docs: add Releasing section to AGENTS.md#367
Open
fcostaoliveira wants to merge 1 commit intoredis:masterfrom
Open
docs: add Releasing section to AGENTS.md#367fcostaoliveira wants to merge 1 commit intoredis:masterfrom
fcostaoliveira wants to merge 1 commit intoredis:masterfrom
Conversation
Captures conventions and process gotchas observed while preparing the 2.3.1 patch release: - The curated release-note style used since 2.2.1 (## Bug Fixes / ## Packaging & Distribution / etc., bold lead phrases, PR numbers in parens), so future agents don't paste the auto-generated GitHub style that was used up to 2.2.0. - The patch-release flow (cherry-pick discovery, branching off the release branch, single combined PR for a patch). - The CI-trigger gap on release branches — workflows historically restricted pull_request to [master, main] only, so PRs targeting a release branch ran zero checks. - utils/prepare_release.sh gotchas: stale version.h not regenerated by make (the rule has no dependencies, so the man page bakes an old git SHA), no branch / version-string sanity checks, no tag creation, the dirty-only untracked-file guard. - Note that release notes should be drafted from `--generate-notes` then rewritten in the curated style before publishing. Co-Authored-By: Claude Opus 4.7 (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.
Summary
Adds a Releasing section to AGENTS.md capturing the conventions and process gotchas observed while shipping the 2.3.1 patch release. Pure documentation — no code change.
The section covers:
## Bug Fixes/## Packaging & Distribution/ etc. format we've used since 2.2.1, with bold lead phrases and PR numbers in parens. Future agents (or a tired maintainer reaching for--generate-notes) had no documented reference for this style.git log master ^<release-branch>), branching off the release branch, single combined PR shape, post-merge tag-and-publish flow.pull_request: branches:filter historically restricted to[master, main], so a PR targeting a release branch ran zero checks. Surfaced during the 2.3.1 release; documented so the next release doesn't rediscover it the hard way.utils/prepare_release.shgotchas — most notably the staleversion.hproblem: the Makefile rule has no dependencies, so onceversion.hexistsmakewon't re-runversion.shand the man page bakes a stale SHA. Also flags the missing branch / version-string sanity checks, missing tag creation, and the dirty-only untracked-file guard.gh release create --generate-notes --draftis a fine starting point but the body must be rewritten in the curated style before publishing.Test plan
🤖 Generated with Claude Code
Note
Low Risk
Low risk documentation-only change with no impact on runtime behavior, build artifacts, or CI configuration.
Overview
Adds a new Releasing section to
AGENTS.mdthat documents the curated GitHub release-note format, the patch-release cherry-pick workflow for release branches, and commonutils/prepare_release.shpitfalls (e.g., staleversion.h, missing tag creation, and CI branch filter gaps).Also notes a recommended workflow for starting from
gh release create --generate-notes --draftand rewriting into the project’s preferred style before publishing.Reviewed by Cursor Bugbot for commit cff1bba. Bugbot is set up for automated code reviews on this repo. Configure here.