docs(docs): document release-please merge-subject trap (#102)#103
Conversation
Closes #102. Adds a new "Common Incidents" entry to docs/_base/RUNBOOKS.md covering the trap hit during the v0.2.8 release: gh pr merge --merge uses the PR title verbatim as the merge-commit subject, so a chore(...) PR title makes release-please skip the bump. Also adds a warning callout to the "Cut a release" block. Symptom + diagnosis + prevention (web UI / --subject / feat: title) + recovery (empty feat(release): trigger commit, ref PRs #99→#100→#101).
There was a problem hiding this comment.
Sorry @w7-mgfcode, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Closes #102. Adds a new "Common Incidents" entry to
docs/_base/RUNBOOKS.mdplus a warning callout under "Cut a release", covering the merge-subject trap that caused release-please to skip the v0.2.8 bump (see #98 recovery story).Background
gh pr merge --mergeuses the PR title as the merge-commit subject. If the PR title is a non-bumping conventional commit (chore(...),docs(...),refactor(...),test(...),ci(...)), release-please will read it at face value and skip — even when the merge contains many underlyingfeat:/fix:commits.Prior dev → main releases were merged via the GitHub web UI, which uses the default
Merge pull request #N from <branch>subject. Non-conventional → release-please traverses the underlying commits → bump fires.What's documented
CD Releaseworkflow ends in ~10s, no Release PR, log says "No user facing commits found".git log origin/main -1 --format='%s'test for the trap.--subject/ non-chore PR title).feat(release):trigger commit pattern, with PRs feat(release): trigger v0.2.8 release for seeder phases 1+2 (#98) #99 → chore(main): release 0.2.8 #100 → chore(repo): sync dev with main after v0.2.8 release (#98) #101 as reference.Note on
.claude/rules/versioning.mdThe issue's acceptance criteria suggested cross-linking from
.claude/rules/versioning.md. The entire.claude/directory is.gitignored (only rootCLAUDE.mdis tracked), so cross-link in that file can't be shipped via PR. Worth filing a separate issue to consider un-ignoring.claude/rules/if those policy files are meant to be shared across contributors (the docs say they are).Test plan
ruffnot relevant (markdown only)dev