-
Notifications
You must be signed in to change notification settings - Fork 10
ci: INT-726 let scoped PRs satisfy their required checks #476
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| name: Required check | ||
| description: >- | ||
| Report a protected check from the job that did the work. Branch protection | ||
| does not accept a skipped check as satisfied, so a tool-scoped PR cannot | ||
| merge while the other tool's jobs skip. A wrapper using this action always | ||
| runs and passes on that job's behalf. | ||
|
|
||
| inputs: | ||
| job: | ||
| description: Name of the job whose outcome is being reported. | ||
| required: true | ||
| result: | ||
| description: result of that job (needs.<job>.result). | ||
| required: true | ||
| gate-result: | ||
| description: >- | ||
| result of the job whose outputs decide whether the work runs. A skip is | ||
| only meaningful if this succeeded; when it did not, the work was skipped | ||
| for an unrelated reason and nothing was verified. | ||
| required: true | ||
|
|
||
| runs: | ||
| using: composite | ||
| steps: | ||
| - shell: bash | ||
| env: | ||
| JOB: ${{ inputs.job }} | ||
| RESULT: ${{ inputs.result }} | ||
| GATE: ${{ inputs.gate-result }} | ||
| run: | | ||
| set -euo pipefail | ||
| if [ "$GATE" != "success" ]; then | ||
| echo "::error::change detection did not succeed (result: $GATE), so $JOB was skipped for an unrelated reason and nothing was verified" | ||
| exit 1 | ||
| fi | ||
| case "$RESULT" in | ||
| success) | ||
| echo "$JOB ran and passed" | ||
| ;; | ||
| skipped) | ||
| echo "$JOB had no relevant changes; nothing to verify" | ||
| ;; | ||
| *) | ||
| echo "::error::$JOB result: $RESULT" | ||
| exit 1 | ||
| ;; | ||
| esac |
This file contains hidden or 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
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.
File-level note: .github/workflows/ci.yml
The gate decision table (7 cases: success/skipped/failure/cancelled combinations of a -run job's result crossed with detect-changes' result) and the actionlint pass the PR cites as verification were both run manually and are not captured anywhere in CI. Nothing in this repo's workflows runs actionlint, and the decision table exists only as prose in the PR body, not as a script/test under version control. This is exactly the class of bug this PR fixes (a workflow-YAML gating mistake that silently breaks required-check enforcement) and it will now recur invisibly: a future edit to required-check/action.yml or to any of the six near-identical wrapper blocks can regress the gate logic (e.g. drop the gate-result check, mis-wire needs, or flip a case) with no CI signal, only manual review to catch it. Add an actionlint step to CI (or a pre-commit/
make linttarget already run in CI) so workflow syntax is checked automatically, and commit the decision-table cases as a small bats/shell test that exercises.github/actions/required-check/action.yml's script directly so a regression fails the build instead of requiring another manual re-verification.Reply inline to this comment.