| token | GitHub token for authentication. Required for tagging and creating releases. The token is masked in logs. | no | ${{ github.token }} |
| prefix | Prefix for the version tag (e.g., "v" produces "v1.2.3"). | no | v |
| default-bump | Bump type when no conventional commit type is found. One of: "patch", "minor", "major", "none", "false". Both "none" and "false" skip the release when no bump is detected. | no | patch |
| initial-version | The version to use when no previous tags exist. Must be a valid semver string (e.g. "0.1.0"). | no | 0.1.0 |
| prerelease | Create a prerelease version. When true, versions are suffixed with the prerelease identifier. Prerelease builds bypass the branches filter and always run. | no | false |
| prerelease-suffix | Identifier appended to prerelease versions (e.g., "beta" → 1.2.3-beta.0). Defaults to the sanitized branch name if not set. | no | "" |
| branches | Comma-separated list of branch patterns (regex, anchored to full name) that trigger releases. Non-matching branches are skipped. Ignored when prerelease is true. | no | main,master |
| create-release | Create a GitHub Release alongside the tag. | no | false |
| release-draft | Create the GitHub Release as a draft. Only takes effect when create-release is true. | no | false |
| release-title | Template for the release title. Use {{version}} and {{tag}} as placeholders. | no | {{tag}} |
| annotated | Create annotated tags (recommended) instead of lightweight tags. | no | true |
| commit-sha | Override the commit SHA to tag. Must be a full 40-character hex SHA. Defaults to GITHUB_SHA. | no | "" |
| dry-run | Calculate the next version and changelog without creating any tags or releases. | no | false |
| custom-rules | Custom conventional commit rules as a comma-separated list.
Format: type:bump[:section]
Examples: "hotfix:patch:Bug Fixes,improvement:minor:Improvements"
| no | "" |
| include-body-in-changelog | Include commit body text in changelog entries. | no | false |
| major-tag | Create/update a floating major version tag (e.g., v2 always points to the latest v2.x.x). Perfect for GitHub Actions. Skipped for prerelease versions. | no | false |
| minor-tag | Create/update a floating minor version tag (e.g., v2.3 always points to the latest v2.3.x). Skipped for prerelease versions. | no | false |