Skip to content

docs: cover GitHub on the index page; branch-prefix reads the head commit - #89

Merged
lesnik512 merged 1 commit into
mainfrom
docs/index-providers
Oct 3, 2026
Merged

lesnik512 merged 1 commit into
mainfrom
docs/index-providers

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

Two doc inaccuracies:

  • docs/index.md described 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 from docs/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.md said 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 feeds BranchPrefixStrategy.decide(commit). Both pages now say it reads the head commit on the default branch, which must be a merge commit.

Checks

  • just lint-ci passes
  • just test: 475 passed
  • mkdocs build --strict passes

@lesnik512
lesnik512 merged commit 8189601 into main Oct 3, 2026
14 checks passed
@lesnik512
lesnik512 deleted the docs/index-providers branch October 3, 2026 15:31
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