Repository navigation
docs(release): adopt the release-stream process - #42
Open
piotr-roslaniec wants to merge 3 commits into
Open
piotr-roslaniec wants to merge 3 commits into
piotr-roslaniec wants to merge 3 commits into
Conversation
Add the release policy, the stream process and the release runbook, plus the PR template and the CI check that enforces it. - docs/release-policy.md: compatibility classes R/P/A/X/T, the v1.x version rule, release count, approvals, security reporting and the current cycle. - docs/release-streams.md: how a change is sorted into a stream, described in its PR, tracked in a parent PR and recorded in the changelog. - docs/release-process.md: the steps to move `[Unreleased]` to a version heading, merge into master, tag and let release.yml publish. - .github/pull_request_template.md and .github/workflows/pr-description.yml (job `required-answers`): require exactly one "Breaking change" answer and one "Security" answer per PR. - .claude/skills/release-streams/SKILL.md: the agent workflow for the above. - README: a Releases section linking the three documents. - CHANGELOG: state the v1.x-only tag rule and drop the pre-release tag example (`go get @latest` would skip a pre-release and select the older v1.3.5).
Name piotr-roslaniec and lrsaturnino as release owners, require a non-author approval for PRs into dev, note that only org admins create v* tags, and point SECURITY.md at GitHub private vulnerability reporting instead of the upstream bounty page.
…rding A workflow re-run checks out the tagged commit, so it cannot pick up a later CHANGELOG fix; say to edit the release body or cut the next patch. Describe tag creation as a procedure rather than an enforced rule, and state the pre-release ordering without claiming a resolution outcome.
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.
Summary
Adopt the release process used by the private
keep-core-securityrepository as thestandard for this library: a release policy, the stream process, a release runbook, a PR
template and the
required-answerscheck that enforces the template.No runtime behavior changes. Every file here is policy, process, CI or docs. GitHub
settings (rulesets, required checks, labels, tag-creation restriction, Issues) are a
separate, later change that follows this PR. SECURITY.md now points to GitHub private
vulnerability reporting, matching the policy and the enabled setting.
Linked issues
Refs #37 (the parent PR for the current stream).
Breaking change
Release stream
devintomaster)Security
Testing
actionlint .github/workflows/pr-description.yml- clean.run:block and drove it directly: no ticks, one tickper section, two ticks in one section, a pre-adoption body with and without the
<!-- pr-template: v1 -->marker, and a CRLF body. The four options of the"Breaking change" section and the two of the "Security" section were each run through
the check; exactly one tick per section passes, anything else fails.
release.yml'sawkextraction against a scratch copy ofCHANGELOG.mdwith theheading renamed to
## [1.4.0] - 2026-10-15: the section is non-empty and stops at thenext
## [; with the heading left as[Unreleased]it is empty, which is why theworkflow fails the run.
Rollback
Revert the commit. Nothing outside the repository depends on these files.
Checklist
type(scope): description).