docs: name the required check version-forward + document planned ruleset migration (#308) - #316
Merged
StefanSteiner merged 1 commit intoSep 8, 2026
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
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.
What & why
Documentation follow-up to #315 (which fixed the release-please
-rc.Nbackward-anchor regression, #308). Two corrections to
docs/GITHUB_OPERATIONS.md→ Branch protection:Correct the required-status-check name. The section told maintainers to
require
verify-release-pr-version— but that is the workflow file name.GitHub's required-check picker lists checks by their check-run (job) name,
which is
version-forward, so searching for the file name finds nothing. (Thisbit us for real: the check wasn't selectable in Settings → Branches until we
searched for
version-forward.) The bullet now namesversion-forward, linksto the workflow file, and explains the file-vs-job distinction so the next
maintainer doesn't hit the same wall.
Document the planned ruleset migration. Adds a note that
mainis guardedby GitHub's classic branch protection today, with a planned conversion to a
ruleset
after the 1.0.0 release ships — deliberately not during the
release-candidate cycle, so branch-gating mechanics don't change mid-release.
The note explains what rulesets add (layering, readable by anyone with repo
access, unified branch + tag governance) and that classic rules and rulesets
coexist (most-restrictive-wins), so the switch can be staged and verified
without a protection gap.
Docs-only — no code or workflow behavior changes.
markdownlint-cli2clean.Related: #308, #315.