Skip to content

docs: Release-As must ride a top-level commit message, not a squash bullet #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Alpaq92 wants to merge 1 commit into from
Closed

docs: Release-As must ride a top-level commit message, not a squash bullet #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ Until that change is made there is no reliable way to batch from the outside;
the closest is the owner approving all queued fix PRs back-to-back and
accepting whatever grouping the merge/release race produces.

### ⚠️ `Release-As:` is only parsed from top-level commit messages
A footer buried inside the **bulleted sub-messages of a multi-commit squash**
(GitHub's default squash body for a 2+-commit PR) is IGNORED — #73 carried
`Release-As: 0.9.0` inside its first bullet and release-please still computed
0.8.16. Pin the version with a commit whose OWN top-level message ends with the
footer: a **single-commit** PR squash preserves the message verbatim (proven by
#64), so a docs/chore micro-PR is the reliable vehicle. Direct pushes to `main`
are blocked by the ruleset, so the empty-commit approach from release-please's
docs doesn't work here.

Comment on lines +50 to +59

@coderabbitai coderabbitai Bot Jul 11, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Avoid starting the line with #64.

markdownlint reports MD018 on Line 56 because the issue reference begins the line with #. Prefix it with PR (or keep it on the preceding line) so the documentation passes lint without losing the issue reference.

Proposed fix 
-footer: a **single-commit** PR squash preserves the message verbatim (proven by
-#64), so a docs/chore micro-PR is the reliable vehicle.
+footer: a **single-commit** PR squash preserves the message verbatim (proven by
+PR `#64`), so a docs/chore micro-PR is the reliable vehicle.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### ⚠️ `Release-As:` is only parsed from top-level commit messages
A footer buried inside the **bulleted sub-messages of a multi-commit squash**
(GitHub's default squash body for a 2+-commit PR) is IGNORED — #73 carried
`Release-As: 0.9.0` inside its first bullet and release-please still computed
0.8.16. Pin the version with a commit whose OWN top-level message ends with the
footer: a **single-commit** PR squash preserves the message verbatim (proven by
#64), so a docs/chore micro-PR is the reliable vehicle. Direct pushes to `main`
are blocked by the ruleset, so the empty-commit approach from release-please's
docs doesn't work here.
### ⚠️ `Release-As:` is only parsed from top-level commit messages
A footer buried inside the **bulleted sub-messages of a multi-commit squash**
(GitHub's default squash body for a 2+-commit PR) is IGNORED — PR `#73` carried
`Release-As: 0.9.0` inside its first bullet and release-please still computed
0.8.16. Pin the version with a commit whose OWN top-level message ends with the
footer: a **single-commit** PR squash preserves the message verbatim (proven by
PR `#64`), so a docs/chore micro-PR is the reliable vehicle. Direct pushes to `main`
are blocked by the ruleset, so the empty-commit approach from release-please's
docs doesn't work here.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 56-56: No space after hash on atx style heading

(MD018, no-missing-space-atx)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CLAUDE.md` around lines 50 - 59, Update the Markdown paragraph in the
Release-As section so the issue reference “#64” is not the first characters of a
line; prefix it with “PR” or move it onto the preceding line while preserving
the existing reference and meaning.

Source: Linters/SAST tools

### ⚠️ `Release-As:` is sticky
A `Release-As: X.Y.Z` commit footer overrides the computed version on every run
until the commit carrying it is released. A stale footer pointing at an
Expand Down