ci: make required checks passed if skipped #37
Merged
Conversation
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
sripwoud
commented
Aug 8, 2024
.github/workflows/main.yml
Outdated
| name: Coveralls | ||
| uses: coverallsapp/github-action@v2 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| parallel: true | ||
| flag-name: run ${{ join(matrix.*, '-') }} | ||
|
|
||
| test: |
There was a problem hiding this comment.
dummy job to wrap _tests
sripwoud
commented
Aug 8, 2024
| @@ -194,3 +207,11 @@ jobs: | |||
| const header = '# Slither report' | |||
| const body = process.env.REPORT | |||
| await script({ github, context, header, body }) | |||
|
|
|||
| slither: | |||
There was a problem hiding this comment.
dummy job to wrap _slither
sripwoud
force-pushed
the
ci/conditional-checks
branch
3 times, most recently
from
f1ddcc1 to
7fd6b85
Compare
cedoor
reviewed
Aug 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix #22
A limitation of GitHub actions is that ci jobs that used as checks required to allow a PR to merge, are always required, even if they were skipped.
In the case they were skipped...well the ci check isn't passed, not allowing a valid PR to merge.
A workaround is to use
${{ !(failure() || cancelled()) }}as a condition, meaning: if the dependents jobs didn't fail or weren't cancelled, execute (especially: if dependents jobs were skipped, execute).This can be used as an
ifcondition in a dummy job that will always be executed and successful, unless the dependents jobs failed or were cancelled. Which is what we want.The workflow diagram illustrates well what is going on:
This PR does not affect any
solfiles, so the_testsand_slithermatrix jobs are all skipped.However
testsandslitherwhich depends on_testsand_slitherrespectively and are used as ci required checks, are still executed and pass, allowing the PR to merge.This will speed up even more the CI, and avoid ci checks being a stuck with
waiting for status to be reportedstate.