chore(ci): Switch to PR Reviews for triggering CI #20892
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,28 +10,23 @@ jobs: | |
| env: | ||
| CARGO_INCREMENTAL: 0 | ||
| steps: | ||
| - name: (PR review) Set latest commit status as pending | ||
| if: ${{ github.event_name == 'pull_request_review' }} | ||
| uses: myrotvorets/[email protected] | ||
| with: | ||
| sha: ${{ github.events.review.commit_id }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| context: CLI - Linux | ||
| status: pending | ||
|
|
||
| - name: (PR review) Checkout review SHA | ||
| if: ${{ github.event_name == 'pull_request_review' }} | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| ref: ${{ github.events.review.commit_id }} | ||
|
|
||
| - name: Checkout branch | ||
| if: ${{ github.event_name != 'pull_request_review' }} | ||
|
Comment on lines
-13
to
+29
There was a problem hiding this comment. you could avoid this construct and create a more hard-linked reference: set an input to this reusable workflow to provide the the pattern is repeated in several reusable workflows. There was a problem hiding this comment. Agreed, I did notice this boilerplate repeated across workflows that could be DRY'd up, but didn't want to attempt that refactoring with this change. |
||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Cache Cargo registry + index | ||
|
|
@@ -54,11 +49,11 @@ jobs: | |
| run: scripts/upload-test-results.sh | ||
| if: always() | ||
|
|
||
| - name: (PR review) Set latest commit status as ${{ job.status }} | ||
| uses: myrotvorets/[email protected] | ||
| if: always() && github.event_name == 'pull_request_review' | ||
| with: | ||
| sha: ${{ github.events.review.commit_id }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| context: CLI - Linux | ||
| status: ${{ job.status }} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ | |
| # | ||
| # Runs on: | ||
| # - scheduled UTC midnight Tues-Sat | ||
| # - on PR review (see comment-trigger.yml) | ||
| # - on demand from github actions UI | ||
|
|
||
| name: Component Features - Linux | ||
|
|
@@ -20,42 +20,37 @@ jobs: | |
| check-component-features: | ||
| # use free tier on schedule and 8 core to expedite results on demand invocation | ||
| runs-on: ${{ github.event_name == 'schedule' && 'ubuntu-latest' || 'ubuntu-20.04-8core' }} | ||
| if: github.event_name == 'pull_request_review' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' | ||
| steps: | ||
| - name: (PR review) Set latest commit status as pending | ||
| if: github.event_name == 'pull_request_review' | ||
| uses: myrotvorets/[email protected] | ||
| with: | ||
| sha: ${{ github.events.review.commit_id }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| context: Component Features - Linux | ||
| status: pending | ||
|
|
||
| - name: (PR review) Checkout PR branch | ||
| if: github.event_name == 'pull_request_review' | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| ref: ${{ github.events.review.commit_id }} | ||
|
|
||
| - name: Checkout branch | ||
| if: github.event_name != 'pull_request_review' | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - run: sudo -E bash scripts/environment/bootstrap-ubuntu-20.04.sh | ||
| - run: bash scripts/environment/prepare.sh | ||
| - run: echo "::add-matcher::.github/matchers/rust.json" | ||
| - run: make check-component-features | ||
|
|
||
| - name: (PR review) Set latest commit status as ${{ job.status }} | ||
| if: always() && github.event_name == 'pull_request_review' | ||
| uses: myrotvorets/[email protected] | ||
| with: | ||
| sha: ${{ github.events.review.commit_id }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| context: Component Features - Linux | ||
| status: ${{ job.status }} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,29 +22,23 @@ jobs: | |
| - arm-unknown-linux-gnueabi | ||
| - arm-unknown-linux-musleabi | ||
| steps: | ||
| - name: (PR review) Set latest commit status as pending | ||
| if: ${{ github.event_name == 'pull_request_review' }} | ||
| uses: myrotvorets/[email protected] | ||
| with: | ||
| sha: ${{ github.events.review.commit_id }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| context: Cross | ||
| status: pending | ||
|
|
||
| - name: (PR review) Checkout PR branch | ||
| if: ${{ github.event_name == 'pull_request_review' }} | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| ref: ${{ github.events.review.commit_id }} | ||
|
|
||
| - name: Checkout branch | ||
| if: ${{ github.event_name != 'pull_request_review' }} | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - uses: actions/cache@v4 | ||
|
|
@@ -70,30 +64,26 @@ jobs: | |
| name: "vector-debug-${{ matrix.target }}" | ||
| path: "./target/${{ matrix.target }}/debug/vector" | ||
|
|
||
| - name: (PR review) Set latest commit status as failed | ||
| uses: myrotvorets/[email protected] | ||
| if: failure() && github.event_name == 'pull_request_review' | ||
| with: | ||
| sha: ${{ steps.comment-branch.outputs.head_sha }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| context: Cross | ||
| status: 'failure' | ||
|
|
||
| update-pr-status: | ||
| name: (PR review) Signal result to PR | ||
| runs-on: ubuntu-20.04 | ||
| timeout-minutes: 5 | ||
| needs: cross-linux | ||
| if: needs.cross-linux.result == 'success' && github.event_name == 'pull_request_review' | ||
| steps: | ||
| - name: (PR review) Submit PR result as success | ||
| uses: myrotvorets/[email protected] | ||
| with: | ||
| sha: ${{ github.events.review.commit_id }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| context: Cross | ||
| status: 'success' | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you need a step here to validate whether the commit it's running on is the latest in the PR? Some labelling and other actions might give a false sense of what has been tested...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it is necessary that the commit be the latest commit in the PR. The workflows will run again as part of the merge queue so if there are breakages they will be caught then. This comment trigger workflow is just to have the ability to trigger them without adding the PR to the merge queue.
An exception is the component features check which doesn't run on the merge queue, instead it runs nightly, but breakages to that are low urgency and can be resolved later.