How do I set up github-tag-action to run on pull request merges?

Use the pull_request event with type closed and branch filter, then add a condition for merged == true. In the checkout step, set ref to the merge commit SHA and fetch-depth to '0' to ensure full commit history for accurate bump detection, as shown in example 2 of the README.

Can github-tag-action handle beta or prerelease versions?

Yes, set the PRERELEASE environment variable to true and optionally customize PRERELEASE_SUFFIX. On non-release branches, it automatically generates prerelease tags with suffixes, allowing for development version tracking.

github-tag-action vs semantic-release: which should I use?

github-tag-action is simpler and tightly integrated with GitHub Actions, using commit message tags for bumps. semantic-release is more feature-rich, supports conventional commits, and can publish to npm, but requires more configuration and external plugins.

How can I skip a version bump with github-tag-action?

Include #none in the commit message or set DEFAULT_BUMP to 'none'. This prevents any automatic bump, giving you manual control over when tags are applied, as explained in the bumping section.

What outputs does github-tag-action provide for use in other steps?

It outputs new_tag, old_tag, tag, and part, which can be referenced in subsequent workflow steps for actions like creating GitHub releases or building artifacts with version-specific labels.

Is github-tag-action compatible with GitHub Enterprise Server?

Likely yes, as it uses standard GitHub APIs, but you may need to ensure the GITHUB_TOKEN has appropriate write permissions and the action is configured for your enterprise environment, including custom default branches.

Open-Awesome

Automatically Bump and Tag on Merge

MITShell1.75.0

A GitHub Action to automatically bump and tag repositories with SemVer versions on merge.

GitHub

873 stars394 forks0 contributors

What is Automatically Bump and Tag on Merge?

github-tag-action is a GitHub Action that automatically increments and applies Semantic Versioning (SemVer) tags to a repository when code is merged. It parses commit messages for version bump indicators and pushes the appropriate tag, eliminating manual version management in CI/CD pipelines.

Target Audience

Developers and DevOps teams using GitHub Actions who want to automate version tagging and enforce SemVer conventions in their release workflows.

Value Proposition

It reduces human error in versioning, integrates seamlessly into GitHub workflows, and offers extensive customization for different branching strategies and tagging preferences.

Overview

A Github Action to tag a repo on merge.

Use Cases

Best For

Automating SemVer tagging in GitHub Actions workflows
Enforcing version bump conventions through commit messages
Generating prerelease tags for feature branches
Integrating version tagging with pull request merges
Simulating version bumps with dry-run outputs
Maintaining consistent versioning across release branches

Not Ideal For

Projects hosted on non-GitHub platforms (e.g., GitLab, Bitbucket) that require automated version tagging
Teams using versioning schemes other than Semantic Versioning, such as calendar versioning or custom incremental numbers
Workflows requiring annotated tags for GPG signing or detailed release metadata
Repositories with highly complex version bump logic that cannot be expressed through commit message tags or the provided environment variables

Pros & Cons

Pros

Commit-Driven SemVer Enforcement

Automatically bumps versions based on commit message tags like #major or #patch, enforcing SemVer conventions without manual intervention, as detailed in the bumping section.

Flexible Branch Strategy Support

Configurable for release and prerelease branches via RELEASE_BRANCHES and PRERELEASE options, allowing stable tags on main and development versions on feature branches.

Highly Customizable Tagging

Offers numerous environment variables for tag prefixes, prerelease suffixes, and bump tokens, enabling fine-grained control over tag generation and history scanning.

Safe Testing with Dry Runs

Includes a DRY_RUN mode to simulate version bumps and expose new_tag outputs, useful for integrating with other workflow steps without pushing tags.

Cons

Uncertain Maintenance Future

The project is actively seeking maintainers per the README, which raises concerns about long-term support, bug fixes, and feature updates.

Configuration Complexity and Pitfalls

Requires careful setup of git history modes and fetch-depth, with documented issues like errors in 'full' history mode and inconsistencies in prerelease handling, as noted in issue #266.

Limited to Lightweight Tags

Only creates lightweight tags, lacking support for annotated tags that are often required for signed releases or detailed metadata in secure workflows.

Frequently Asked Questions

Related Projects

Create a PR for Changes to your Repository in the Actions Workspace

A GitHub action to create a pull request for changes to your repository in the actions workspace

Stars2,802

Forks545

Last commit18 days ago

Automatically merge PRs That Are Ready

GitHub action to automatically merge pull requests that are ready

Stars920

Forks217

Last commit1 year ago

Automatically Rebase a PR

GitHub Action to automatically rebase PRs

Stars702

Forks141

Last commit2 years ago

Auto-Approve PRs

👍 GitHub Action for automatically approving GitHub pull requests

Stars476

Forks94