Skip to content

docs: correct default branch prefixes and explain seeding the first tag - #87

Merged
lesnik512 merged 1 commit into
mainfrom
docs/fix-prefixes-and-tags
Oct 3, 2026
Merged

lesnik512 merged 1 commit into
mainfrom
docs/fix-prefixes-and-tags

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

The docs pointed users at setups that silently do nothing:

  • The GitHub and GitLab provider pages said fix/ bumps patch and feat/ bumps minor. The default branch-prefix config matches feature/ (minor) and bugfix//hotfix/ (patch), so those branches produce no bump.
  • The tag output example was v1.2.3. semvertag creates unprefixed tags, and v-prefixed tags fail semver.Version.parse and are skipped.
  • Nothing said a first tag must exist. Without one, every run reports no_tags and exits 0, and the reason text cited a stale "v1.0".

Changes

  • Provider pages use the real default prefixes and a 1.2.3 example (also in action.yml).
  • README, docs/index.md and both provider quick starts say to create a plain semver tag such as 0.1.0 first.
  • The no_tags wire reason and the terminal message now say to create an initial tag on a default-branch commit. Both are edited together, per the comment in _outcome.py; tests cover both.
  • The README branch-prefix bullet says the prefix is matched in the merge subject, which is what BranchPrefixStrategy.decide does, instead of "starts with".

Checklist

  • Lint and format pass (ruff)
  • Type check passes (ty)
  • Tests pass and new behavior is covered
  • Build succeeds (uv build) if packaging or build config changed: n/a
  • Repo metadata stays consistent across the three surfaces (GitHub description, pyproject description, profile blurb) if this touches packaging: n/a

The provider docs showed fix/ and feat/ branches, which the default
branch-prefix config ignores (defaults are feature/, bugfix/, hotfix/).
The tag output example used v1.2.3, but v-prefixed tags do not parse and
semvertag creates unprefixed ones. Nothing said a first tag must exist;
the no_tags message now tells the user to push one instead of citing v1.0.
@lesnik512
lesnik512 merged commit ec2e331 into main Oct 3, 2026
14 checks passed
@lesnik512
lesnik512 deleted the docs/fix-prefixes-and-tags branch October 3, 2026 09:16
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