docs: correct default branch prefixes and explain seeding the first tag - #87
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs pointed users at setups that silently do nothing:
fix/bumps patch andfeat/bumps minor. The default branch-prefix config matchesfeature/(minor) andbugfix//hotfix/(patch), so those branches produce no bump.tagoutput example wasv1.2.3. semvertag creates unprefixed tags, andv-prefixed tags failsemver.Version.parseand are skipped.no_tagsand exits 0, and the reason text cited a stale "v1.0".Changes
1.2.3example (also inaction.yml).docs/index.mdand both provider quick starts say to create a plain semver tag such as0.1.0first.no_tagswire 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.BranchPrefixStrategy.decidedoes, instead of "starts with".Checklist
ruff)ty)uv build) if packaging or build config changed: n/adescription, profile blurb) if this touches packaging: n/a