Skip to content

AI-powered virtual executive team — a single coherent executive persona backed by 8 specialist agents (FastAPI + Next.js).

docs(release): carry Release-As in a commit-override block (#211)

Rufus92ef9a49df28
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
index b7f5e717..2abd5348 100644
--- a/.github/workflows/release-please.yml
+++ b/.github/workflows/release-please.yml
@@ -10,12 +10,14 @@
# Merges that are only chore/docs/test/refactor do not start a release on
# their own; they ride along with the next feat or fix.
#
-# To pick a bigger version without calling anything breaking, end a PR
-# description with a `Release-As: X.Y.Z` line; it lands on main as a commit
-# footer and sets the next release only. To correct a merged PR's message
-# (e.g. drop a wrong `!`), add a BEGIN_COMMIT_OVERRIDE / END_COMMIT_OVERRIDE
-# block holding the corrected message to that PR's description; it is read
-# on the next push to main.
+# To pick a bigger version without calling anything breaking, end one PR's
+# description with a BEGIN_COMMIT_OVERRIDE / END_COMMIT_OVERRIDE block holding
+# the PR title, a blank line, and `Release-As: X.Y.Z`; release-please reads it
+# in place of the squash message and applies it to the next release only. A
+# bare `Release-As:` line in the description is not enough: footers count only
+# in the commit's final paragraph, and text appended on merge pushes it out.
+# The same block with a corrected message fixes a merged PR (e.g. drops a
+# wrong `!`). Either is read on the next push to main.
#
# Merging the release PR makes this workflow tag the merge commit `vX.Y.Z`
# and create the GitHub Release from the changelog entry. The tag push then
diff --git a/CLAUDE.md b/CLAUDE.md
index 5ab9912a..82433aa2 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -226,12 +226,16 @@ cd evals && python run_evals.py --scenarios scenarios/ --output results/
messages do not reach `main`.
- `!` / `BREAKING CHANGE:` only for a real break (a removed or reshaped
endpoint, a new required env var, a migration an operator must run) — never
- to get a bigger bump. To release a larger version for any other reason, end
- one PR's description with a `Release-As: X.Y.Z` line (the squash body is the
- PR body, so it lands on `main` as a footer). It applies to the next release
- only. To un-mark a merged PR, add a `BEGIN_COMMIT_OVERRIDE` /
- `END_COMMIT_OVERRIDE` block with the corrected message to its description;
- release-please picks it up on the next push to `main`.
+ to get a bigger bump. To release a larger version for any other reason, put
+ a `BEGIN_COMMIT_OVERRIDE` / `END_COMMIT_OVERRIDE` block at the end of one
+ PR's description holding that PR's title, a blank line, then
+ `Release-As: X.Y.Z`. release-please reads the block in place of the squash
+ message. A bare `Release-As:` line in the description does not work:
+ release-please only reads footers in the commit's final paragraph, and
+ GitHub or the Claude footer appends text after it (#210). It applies to the
+ next release only. The same block with a corrected message un-marks a
+ merged PR (e.g. drops a wrong `!`). Either takes effect on the next push to
+ `main`.
- PR description is three sections and nothing else: **Problem**, **Approach**,
**Checklist** (see `.github/PULL_REQUEST_TEMPLATE.md`). Rationale, review
findings and alternatives go in the commit message; open questions go in the