docs: warn that describing the skip-ci token in a commit message suppresses CI - #30
Merged
Merged
Conversation
…resses CI GitHub scans the whole commit message, not just the subject, so a commit that merely explains the wave technique matches its own skip marker and suppresses every workflow on the resulting PR. This already happened once: the commit that added fleet-operations.md described the pattern in its body, and PR #29 came back with zero check runs. That failure mode is nastier than a red check — absent checks look identical to checks that have not started yet, so the PR reads as healthy and an admin merge would sail through unvalidated. Recorded next to the wave procedure, since that is the context in which someone will next be tempted to write the token in prose.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
One-paragraph addition to
docs/fleet-operations.md, next to the wave procedure.GitHub scans the whole commit message, not just the subject, so a commit that merely describes the skip marker matches it and suppresses every workflow on the resulting PR.
This already happened: the commit that added
fleet-operations.mdexplained the wave pattern in its body, and #29 came back with zero check runs. That is a worse failure mode than a red check — absent checks look identical to checks that have not started, so the PR reads as healthy and an admin merge would go through unvalidated.The note says to write it as
skip-ciin prose, and to grep the commit message first if a PR ever reports no checks at all.