tagpr documentation
tagpr documentation
tagpr prepares a release pull request for unreleased changes, then tags the merged commit and optionally creates a GitHub Release. It makes release preparation automated and repeatable while keeping the release decision visible and reviewable.
Start here
- Getting started explains the complete path from adding the workflow to merging the first release pull request.
- Adopting tagpr in an existing project explains how to choose a release baseline and transition existing changelog and publishing automation.
- Release flow and design explains the lifecycle of the release pull request and the reasoning behind it.
- Versioning and label rules explains SemVer proposals, custom labels, version-file precedence, and CalVer behavior.
- Changelog and GitHub Releases
explains how tagpr
uses GitHub’s generated release notes and
.github/release.yml. - Release preparation commands explains how to automate project-specific file changes before release.
- Publishing after a release explains how to publish artifacts or deploy after tagpr creates a tag.
- Immutable GitHub Releases explains how to attach assets before publication by coordinating tagpr with a later release workflow.
- Configuration index groups the available settings by purpose and links to the complete reference.
- Release pull request templates documents title and body customization.
Common goals
| Goal | Documentation |
|---|---|
| Install tagpr | Getting started |
| Adopt tagpr in an existing project | Adoption guide |
| Release without a version file | Tag-only releases |
| Select a major or minor version | Versioning and label rules |
| Use Calendar Versioning | Configuration index |
| Release projects in a monorepo | Configuration index |
| Customize changelog categories | Changelog and GitHub Releases |
| Customize the release pull request | Release pull request templates |
| Run project-specific release changes | Release preparation commands |
| Publish from the same workflow | Publishing after a release |
| Trigger a separate workflow | Publishing after a release |
| Publish assets with immutable releases | Immutable GitHub Releases |
| Reuse a tagpr draft with GoReleaser | Immutable GitHub Releases |
| Diagnose a setup problem | README troubleshooting |
Reference
The complete configuration, GitHub Action inputs, outputs, environment variables, and GitHub Enterprise instructions currently remain in the README . They will stay there until equivalent standalone reference pages are complete, so no documentation is lost during the transition to a documentation site.