Skip to content

docs(docs): document release-please merge-subject trap (#102)#103

Merged
w7-mgfcode merged 1 commit into
devfrom
docs/runbook-release-please-merge-trap
May 12, 2026
Merged

docs(docs): document release-please merge-subject trap (#102)#103
w7-mgfcode merged 1 commit into
devfrom
docs/runbook-release-please-merge-trap

Conversation

@w7-mgfcode
Copy link
Copy Markdown
Owner

Summary

Closes #102. Adds a new "Common Incidents" entry to docs/_base/RUNBOOKS.md plus 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 --merge uses 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 underlying feat: / 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

Note on .claude/rules/versioning.md

The issue's acceptance criteria suggested cross-linking from .claude/rules/versioning.md. The entire .claude/ directory is .gitignored (only root CLAUDE.md is 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

  • ruff not relevant (markdown only)
  • No code change
  • CI green
  • Merge to dev

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).
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Sorry @w7-mgfcode, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f6f0b668-a37a-4f65-8558-c9d9f987599b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/runbook-release-please-merge-trap

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@w7-mgfcode w7-mgfcode merged commit 9990e57 into dev May 12, 2026
8 checks passed
@w7-mgfcode w7-mgfcode deleted the docs/runbook-release-please-merge-trap branch May 12, 2026 03:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant