From 36e5c27de41db0def915b7b78ff7492651171651 Mon Sep 17 00:00:00 2001 From: Andreas Richardson Date: Fri, 11 Sep 2026 18:02:22 +0100 Subject: [PATCH] docs: correct how release-please decides a version bump The gotcha claimed release-please "counts only `feat` and breaking changes toward a bump". Any visible type that is not `feat` or breaking bumps a patch, and `release-type: python` makes `docs` visible where the shared default hides it, which is why docs-only commits open a release PR here. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_011mJ5NaA5DdPxqa1Mb4UJhT --- AGENTS.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 2a55a80..6914eeb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -167,10 +167,18 @@ Two keys, and the difference matters: - **TIM cannot be asked twice.** It won't price a departed flight, so anything not captured while it was upcoming is gone permanently. - **A runtime dependency bump must be `fix(deps):`, not `chore(deps):`.** - release-please hides `chore` by default and counts only `feat` and breaking - changes toward a bump, so a `chore(deps)` bump of a runtime dependency changes - what users install with nothing in the changelog and no release. Dev + `chore` is hidden from the changelog, and a stretch of hidden types alone + opens no release PR at all, so a `chore(deps)` bump of a runtime dependency + changes what users install with nothing in the changelog and no release. Dev dependencies stay `chore(deps-dev):`. +- **`docs:` cuts a patch release, and that is accepted here.** The `python` + release type replaces release-please's default changelog sections with + google-cloud-python's, which make `docs` and `deps` visible; the shared + default hides `docs`, so the `node` release type would behave differently. Any + visible type that is not `feat` or breaking bumps a patch, so a single docs + commit on `main` opens a release PR. The hidden types (`chore`, `ci`, `test`, + `refactor`, `style`, `build`) render empty notes and are skipped, which is why + a run of `ci:` commits stays quiet. - **The two install pins in `README.md`, and the two version placeholders in `.github/ISSUE_TEMPLATE/bug_report.yml`, are rewritten by release-please**, not by hand. They sit inside `x-release-please-start-version` /