Skip to content

fix: release-please tag format#10

Merged
StuBehan merged 1 commit into
mainfrom
fix/release-please-tag-format
Apr 22, 2026
Merged

fix: release-please tag format#10
StuBehan merged 1 commit into
mainfrom
fix/release-please-tag-format

Conversation

@StuBehan
Copy link
Copy Markdown
Collaborator

Summary

Fixes the recurring "first commit appears as a 0.3.0 Feature" problem in release-please PRs (see PR #7 for the latest example).

Diagnosis

release-please's compare URL was pointing at `stackvox-v0.2.0...stackvox-v0.3.0` — i.e. it's been expecting tags of the form `stackvox-v{version}` the whole time. Our actual tag is just `v0.2.0` because we're a single-package repo. release-please couldn't resolve its expected lower-bound tag, so it fell back to walking history from the beginning, and every commit in the repo ended up in the proposed release.

The default for `include-component-in-tag` is `true` in release-please's manifest mode, even for single-package setups. We never overrode it.

Fix

Adds `"include-component-in-tag": false` to `release-please-config.json`. Now release-please will look for / generate `v{version}` tags, matching the one we already have.

What happens after merge

  • On the next push to `main`, release-please will re-run with the corrected config.
  • It'll find `v0.2.0` as the baseline, close PR chore(main): release 0.2.1 #7 (since its content is now stale), and open a fresh release PR whose compare starts at `v0.2.0` — no more "first commit" entries, and only genuinely-unreleased commits.
  • Future tags continue as `v0.2.1`, `v0.3.0`, etc.

Test plan

  • CI passes.
  • After merge, observe that PR chore(main): release 0.2.1 #7 is auto-closed and a replacement release PR opens with a correct changelog diff starting at v0.2.0.

release-please defaulted to include-component-in-tag: true, so it was
expecting tags like `stackvox-v0.2.0`. Our actual tag is `v0.2.0`
(single-package repo, no need for a package prefix). Release-please
couldn't locate its expected lower-bound tag and fell back to
"walk all history", which is why every release PR re-listed
`feat(stackvox): first commit` under the new version's Features.

Setting include-component-in-tag: false aligns the config with the
tag format actually in use. On next push to main, release-please
will close PR #7 and regenerate a clean release PR whose diff starts
at the v0.2.0 tag.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@StuBehan StuBehan merged commit baee1d8 into main Apr 22, 2026
9 checks passed
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