docs: add operator upgrade release notes and a required-note check - #2191
Open
cardoe wants to merge 2 commits into
Open
docs: add operator upgrade release notes and a required-note check#2191cardoe wants to merge 2 commits into
cardoe wants to merge 2 commits into
Conversation
GitHub release bodies are auto-generated PR lists: they say what changed but not what an operator has to *do* about it. This adds a place to record required deploy repo changes, new secrets, and one-time manual steps. One page per minor series, versions newest-first. A version needing no operator action gets no section, so most versions are absent; empty pages would only teach operators not to open them. The Unreleased section is authored in the same PR as each change, so it is immediately visible to deployments tracking main (understack_ref defaults to HEAD). No history is reconstructed: per-version notes start at the next tag, and the v0.4.25-and-earlier stub links only the upgrade guides that exist. MD024 becomes siblings_only so repeated per-section headings (e.g. "Action required") lint cleanly.
Adds RELEASING.md (the tag-cutting checklist and section template) plus a check that a flagged change actually documents itself. A PR is flagged either by the upgrade-impact label or by `!` in the title; the check is a no-op otherwise, so Renovate and routine PRs see no new friction. Commit-type autodetection is not used, since the history has no `!` or BREAKING CHANGE markers to key off. The workflow has no paths: filter (a path-filtered workflow reports no status on non-matching PRs and so can never be marked required) and runs with only contents: read, passing the title via the environment, so it works on fork PRs.
cardoe
changed the title
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.
Adds operator-facing upgrade notes under
docs/release-notes/— one page per minor series, versions newest-first, with anUnreleasedsection authored alongside each change so deployments trackingmainsee it immediately. Only versions that need operator action get a section.Adds
RELEASING.md(tag-cutting checklist + section template) and a CI check that fails when a PR flagged upgrade-impacting (via theupgrade-impactlabel or!in the title) doesn't touchdocs/release-notes/. Routine PRs are unaffected.