docs: say to alert on base-branch failure - #1
Merged
Conversation
…push run The README told consumers to run the check on push to the base branch and called that 'what makes the guard never silently wrong'. It isn't, on its own: when the guard fails on push the offending PR has already merged and its author has moved on, so the only signals are a red mark on a commit nobody revisits and GitHub's default mail to the merger. Detection nobody is told about is not detection. Adds the missing step to 'Where to run it' with a snippet, guarded on the base branch so PR runs stay quiet. Found by shipping the silent version into fullstackhouse/tournee, where every other workflow alerts and this one did not.
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
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.
Problem
The README's Where to run it section tells you to run the check on
pushto the base branch, and calls that run "what makes the guard never silently wrong."It isn't, on its own — and following the README as written gets you a guard nobody hears. When the check fails on
push, the colliding PR has already merged and its author has moved on. The only signals left are a red mark on a commit nobody revisits and whatever mail GitHub sends the person who pressed Merge. Detection nobody is told about is not detection.The timing is what makes this matter rather than being a nitpick: a duplicate id costs minutes to fix the hour it lands, and a full citation sweep a month later once it is in tracker tasks, merged PR titles and code comments. The
pushalert is the thing that buys the cheap version.Found the honest way — by shipping the silent version.
fullstackhouse/tourneeadopted this action with apush: maintrigger and no alerting step, while every other workflow in that repo notifies its alerts channel on amainfailure. The one guard whose failure nobody is watching for was the one that stayed quiet (tournee#1041 fixes it there). The original pre-extraction version of this check wired itself into a sharednotify-failurejob and said so in a comment; the extraction dropped it and the README never asked for it back.Change
Docs only.
slack-notify-action.github.ref_name == 'main'— on apull_requestthe red check already sits on a PR its author is looking at, so alerting there is noise.pushbullet.No change to
action.ymlorscripts/check.sh. Alerting stays the consumer's step rather than an input: it is repo-specific (channel, token, transport) and the action has no business knowing about Slack.