Use 'not success' checks instead of specific failure conditions #1555
+7
−7
Conversation
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
Change the checks job to test for 'result != success' instead of explicitly checking for 'cancelled' or 'failure' states. This is safer because: 1. It catches all non-success states (cancelled, failure, skipped, or any unexpected future states that GitHub might introduce) 2. It follows a 'fail closed' approach: if we don't know the state is success, we fail 3. It's simpler and more maintainable than listing specific failure conditions The possible values for needs.<job>.result are: success, failure, cancelled, or skipped. By checking for 'not success', we ensure we catch any unexpected states and err on the safer side.
Contributor
|
Auto-sync is disabled for ready for review pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
kkraus14
reviewed
Jan 31, 2026
| # skipped and should not cause failure. | ||
| doc_only=${{ needs.should-skip.outputs.doc-only }} | ||
| if ${{ needs.doc.result == 'cancelled' || needs.doc.result == 'failure' }}; then | ||
| # Fail if doc job didn't succeed (covers cancelled, failure, skipped, or any unexpected state) |
Collaborator
There was a problem hiding this comment.
This will prevent the [no-ci] support from working properly as that intentionally skips the jobs and that's not a failure that should prevent merging.
Collaborator
Author
There was a problem hiding this comment.
Ah, of course, it's right there in the comment 🤦♂️, I missed it before. Thanks!
So it'd would have to be result != 'success' && result != 'skipped', and it will not matter unless github adds a new state. Seems unlikely, I don't want to waste CI time on this subtle change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
@kkraus14 this is a mix of suggestion & question. It boils down to: How do we want to handle the
skippedcondition?Change the checks job to test for
result != 'success'instead of explicitly checking for'cancelled'or'failure'states. This is safer because:It catches all non-success states - cancelled, failure, skipped, or any unexpected future states that GitHub might introduce
It follows a 'fail closed' approach - if we don't know the state is success, we fail
It's simpler and more maintainable - no need to list specific failure conditions
The possible values for
needs.<job>.resultare:success,failure,cancelled, orskipped. By checking for 'not success', we ensure we catch any unexpected states and err on the safer side.Changes
result == 'cancelled' || result == 'failure'→result != 'success'result == 'cancelled' || result == 'failure'→result != 'success'