Skip to content

Commit

Permalink
always check out the github.head_ref in CI
Browse files Browse the repository at this point in the history 
The default behavior for the `actions/checkout` is to check out the `github.ref` commit.

In the case of `pull_request_target` triggers, the `github.ref` commit is the last commit on the target branch (typically `main`), instead of the PR branch:

https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target

> This event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the pull_request event does.

Unfortunately, that means that unless we specify the correct PR branch,
the `kotlin.yml` workflow jobs will just execute against the `main`.
  • Loading branch information
@RBusarow
RBusarow committed Feb 23, 2024
1 parent a3aa2e7 commit b61c214
Showing 1 changed file with 72 additions and 18 deletions.
90 changes: 72 additions & 18 deletions .github/workflows/kotlin.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ jobs :
name : Build all
runs-on : workflow-kotlin-test-runner-ubuntu-4core
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

- name : main build
uses : ./.github/actions/gradle-task
Expand All @@ -39,7 +42,10 @@ jobs :
runs-on : ubuntu-latest
needs : build-all
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

- name : Run dokka to validate kdoc
uses : ./.github/actions/gradle-task
Expand All @@ -51,7 +57,10 @@ jobs :
name : Shard Matrix Yaml
runs-on : workflow-kotlin-test-runner-ubuntu-4core
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

- name : check published artifacts
uses : ./.github/actions/gradle-task-with-commit
Expand All @@ -66,7 +75,10 @@ jobs :
# the `artifactsCheck` task has to run on macOS in order to see the iOS KMP artifacts
runs-on : macos-latest
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

- name : check published artifacts
uses : ./.github/actions/gradle-task-with-commit
Expand All @@ -80,7 +92,10 @@ jobs :
name : Dependency Guard
runs-on : ubuntu-latest
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

# If the PR was made by a maintainer or Renovate, automatically update baselines and push
# so that no one has to check out the branch and update the baselines manually.
Expand All @@ -96,7 +111,10 @@ jobs :
name : KtLint
runs-on : ubuntu-latest
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

# If the PR was made by a maintainer or Renovate, automatically format and push
# so that no one has to check out the branch and do it manually.
Expand All @@ -112,7 +130,10 @@ jobs :
name : Api check
runs-on : ubuntu-latest
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

# If the PR was made by a maintainer or Renovate, automatically format and push
# so that no one has to check out the branch and do it manually.
Expand All @@ -130,7 +151,10 @@ jobs :
needs : build-all
timeout-minutes : 20
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}
- name : Check with Gradle
uses : ./.github/actions/gradle-task
with :
Expand All @@ -143,7 +167,10 @@ jobs :
needs : build-all
timeout-minutes : 20
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}
- name : Check with Gradle
uses : ./.github/actions/gradle-task
with :
Expand All @@ -167,7 +194,10 @@ jobs :
timeout-minutes : 15
steps :
# These setup steps should be common across all jobs in this workflow.
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}
- name : build tutorials
uses : ./.github/actions/gradle-task
with :
Expand All @@ -180,7 +210,10 @@ jobs :
runs-on : ubuntu-latest
timeout-minutes : 20
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}
- name : Check with Gradle
uses : ./.github/actions/gradle-task
with :
Expand All @@ -199,7 +232,10 @@ jobs :
runs-on : ubuntu-latest
timeout-minutes : 20
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}
- name : Check with Gradle
uses : ./.github/actions/gradle-task
with :
Expand All @@ -218,7 +254,10 @@ jobs :
runs-on : ubuntu-latest
timeout-minutes : 20
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}
- name : Check with Gradle
uses : ./.github/actions/gradle-task
with :
Expand All @@ -237,7 +276,10 @@ jobs :
runs-on : macos-latest
timeout-minutes : 30
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}
- name : Check with Gradle
uses : ./.github/actions/gradle-task
with :
Expand All @@ -256,7 +298,10 @@ jobs :
runs-on : ubuntu-latest
timeout-minutes : 20
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

## JS Specific Tests (for KMP js actuals in core and runtime).
- name : Check with Gradle
Expand All @@ -283,7 +328,10 @@ jobs :
api-level :
- 31
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

- name : Instrumented tests
uses : ./.github/actions/gradle-tasks-with-emulator
Expand All @@ -307,7 +355,10 @@ jobs :
shardNum: [ 1, 2, 3 ]
### <end-connected-check-shards>
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

- name : Instrumented tests
uses : ./.github/actions/gradle-tasks-with-emulator
Expand All @@ -333,7 +384,10 @@ jobs :
### <end-connected-check-shards>
runtime : [ conflate, baseline-stateChange, conflate-stateChange ]
steps :
- uses : actions/checkout@v3
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.head_ref }}

- name : Instrumented tests
uses : ./.github/actions/gradle-tasks-with-emulator
Expand Down

0 comments on commit b61c214

Please sign in to comment.