Report CI failures through GitHub issues #413
Open
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
Report failures for all jobs but `write-install-commands`, which is more of an intermediate helper than something to report errors for. If this gets noisy for any particular job, it can be ignored by removing the job id from the dependency list.
2 tasks
tsibley
requested changes
Mar 4, 2025
.github/workflows/ci.yaml
Outdated
| - test-standalone | ||
| - doc | ||
| - release | ||
| uses: nextstrain/.github/.github/workflows/report-failure.yaml |
There was a problem hiding this comment.
I believe the @ref is required by uses:.
Suggested change
| uses: nextstrain/.github/.github/workflows/report-failure.yaml | |
| uses: nextstrain/.github/.github/workflows/report-failure.yaml@master |
Comment on lines
+406
to
+414
| failure: ${{ contains(needs.*.result, 'failure') }} | ||
|
|
||
| # The condition evaluates to true when all results are 'success', | ||
| # 'cancelled', or 'skipped'¹. This is not ideal, since a workflow that is | ||
| # cancelled before there are any successes will still signal a success to | ||
| # this job, however the chance of that happening should be very low given | ||
| # that this is job is conditioned on the default branch. | ||
| # ¹ <https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#jobs-context> | ||
| success: ${{ !contains(needs.*.result, 'failure') }} |
There was a problem hiding this comment.
Especially in consideration of nextstrain/.github#121 (comment), I'd think to define this more like:
with:
# At least one success, no failures.
ok: ${{ contains(needs.*.result, 'success') && !contains(needs.*.result, 'failure') }}Or maybe stepping back a bit and doing this sort of thing instead to not "redefine" what success/failure means:
report-failure:
if: ${{ failure() && github.ref_name == github.event.repository.default_branch }}
needs:
- lint
- test-source
- build-dist
- build-standalone
- test-dist
- test-standalone
- doc
- release
uses: nextstrain/.github/.github/workflows/report-failure.yaml@master
with:
ok: false
title: CI failure
report-success:
if: ${{ success() && github.ref_name == github.event.repository.default_branch }}
needs:
- lint
- test-source
- build-dist
- build-standalone
- test-dist
- test-standalone
- doc
- release
uses: nextstrain/.github/.github/workflows/report-failure.yaml@master
with:
ok: true
title: CI failureI wonder if the above can be reduced in verbosity, but I just wanted to show the idea of reusing the failure() and success() functions. The docs imply they can only be used in if: fields.
Comment on lines
+395
to
+403
| needs: | ||
| - lint | ||
| - test-source | ||
| - build-dist | ||
| - build-standalone | ||
| - test-dist | ||
| - test-standalone | ||
| - doc | ||
| - release |
There was a problem hiding this comment.
non-blocking
It feels like it's going to be easy to forget to update this if we add new jobs. :/
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.
Description of proposed changes
Report failures for all jobs but
write-install-commands, which is more of an intermediate helper than something to report errors for.If this gets noisy for any particular job, it can be ignored by removing the job id from the dependency list.
Related issue(s)
Closes #412
Checklist