commitizen-tools/Bump and changelog using commitizen
Create a commit bumping the version of your project and creating a changelog file
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Feb 17, 2026
- License
- MIT
Pinned Snippet
uses: commitizen-tools/commitizen-action@338bbd841b75aaee6bf5340e1fa12f6ab58ff9ff # 0.27.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| working_directory | Change to this directory before running | no | — |
| dry_run | Run without creating commit, output to stdout | no | — |
| commit | If true a commit is created containing the bump changes | no | true |
| push | If true the bump commit is pushed to the remote repository | no | true |
| merge | If true, the bump commit is pushed to the remote repository even when the action is run on the pull_request event, immediately merging the pull request | no | false |
| prerelease | Set as prerelease version | no | — |
| devrelease | Non-negative integer for dev. release | no | — |
| local_version | Bump only the local version portion | no | false |
| build_metadata | Specifies additional metadata in the version string. | no | "" |
| changelog | Create changelog when bumping the version | no | true |
| github_token | Token for the repo. Can be passed in using $\{{ secrets.GITHUB_TOKEN }} | no | — |
| repository | Repository name to push. Default or empty value represents current github repository (${GITHUB_REPOSITORY}) | no | "" |
| branch | Destination branch to push changes | no | "" |
| extra_requirements | Extra commitizen dependencies like your custom plugins or rules | no | "" |
| changelog_increment_filename | Filename to store the incremented generated changelog. This is different to changelog as it only contains the changes for the just generated version | no | — |
| git_redirect_stderr | Redirect git output to stderr. Useful if you do not want git output in your changelog | no | false |
| git_name | Name used to configure git (for git operations) | no | github-actions[bot] |
| git_email | Email address used to configure git (for git operations) | no | github-actions[bot]@users.noreply.github.com |
| commitizen_version | Specify the version to be used by commitizen | no | latest |
| no_raise | Don't raise the given comma-delimited exit codes | no | 21 |
| increment | Manually specify the desired increment | no | — |
| check_consistency | check consistency among versions defined in commitizen configuration and version_files | no | false |
| gpg_sign | If true, use GPG to sign commits and tags (for git operations). Requires separate setup of GPG key and passphrase in GitHub Actions (e.g. with the action crazy-max/ghaction-import-gpg) | no | false |
| debug | If true, prints debug output to GitHub Actions stdout. | no | false |
| actor | The account that will be used to perform git operations, defaults to the GITHUB_ACTOR | no | — |
| manual_version | Manually specify the version to bump to | no | — |
Outputs
| name | description |
|---|---|
| version | New version |
| next_version | Next version |
| next_version_major | Only the major version of the next version |
| next_version_minor | Only the minor version of the next version |
| previous_version | Version before the bump |
| previous_version_major | Only the major version of the previous version |
| previous_version_minor | Only the minor version of the previous version |