docs: document branch protection and the release PR's manual step - #8
Merged
Conversation
Records what the 1.0.2 release cost to find out, none of which is visible from the config files themselves: - main is protected, which is also why this repo is public (branch protection is a paid feature on private repos), and ci-green is the single required check because the per-stack job names come from a matrix over `ls stacks`; - "require branches to be up to date" is off on purpose, since release-please leaves the release branch behind main whenever the notes do not change; - a release PR gets no CI run at all, because workflows are not triggered by GITHUB_TOKEN events, so a required check that never reports leaves it BLOCKED with nothing failing to look at. Close and reopen it, or give release-please a PAT; - a pull_request run uses the workflow file from the head branch, not the merge commit, so a check added to main after the release branch was cut never shows up on that PR. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Records what cutting 1.0.2 cost to find out. None of it is visible from the config files themselves, and all of it would have to be rediscovered the same way.
mainis protected — which is also why this repo is public, since branch protection is a paid feature on private repos (the API answersUpgrade to GitHub Pro or make this repository public).ci-greenis the single required check, because the per-stack job names come from a matrix overls stacksand change whenever a stack is added or removed.mainwhenever achore/ci/docscommit lands (PR remained the same). With that setting on, every release PR would be born unmergeable.GITHUB_TOKEN, soci-greennever reports and the PR sitsBLOCKEDwith zero failing checks to explain it. Closing and reopening it from a user account creates the run; a PAT would remove the step permanently, at the cost of a secret to rotate.pull_requestrun uses the workflow file from the head branch, not from the merge commit — so a check added tomainafter the release branch was cut never appears on that PR, and the branch has to be recreated.🤖 Generated with Claude Code