docs: cover GitHub on the index page; branch-prefix reads the head commit - #89
Merged
Merged
Conversation
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
Two doc inaccuracies:
docs/index.mddescribed semvertag as a GitLab tool ("Auto-tag your GitLab repository", "from your GitLab project") and showed only a GitLab quick start, although GitHub is a supported provider (semvertag/providers/github.py,docs/providers/github.md). The intro now names both providers, and the quick start has a GitHub Actions snippet (copied fromdocs/providers/github.md) next to the GitLab one. The first-tag note moves above both snippets, and the local-run example is labelled as GitLab.docs/strategies/branch-prefix.mdsaid the strategy inspects "the subject line of each commit", and the index said "the latest merge commit". The strategy decides on one commit:get_latest_commit_on_default_branch()in each provider feedsBranchPrefixStrategy.decide(commit). Both pages now say it reads the head commit on the default branch, which must be a merge commit.Checks
just lint-cipassesjust test: 475 passedmkdocs build --strictpasses