Add commitizen incredibly fast into your project!
- Allow prerelease
- Super easy to setup
- Automatically bump version
- Automatically create changelog
- Update any file in your repo with the new version
Are you using conventional commits and semver?
Then you are ready to use this github action! The only thing you'll need is the .cz.toml file in your project.
- In your repository create a
.cz.tomlfile (you can runcz initto create it) - Create a
.github/workflows/bumpversion.yamlwith the Sample Workflow
Your .cz.toml (or pyproject.toml if you are using python) should look like this.
[tool.commitizen] version = "0.1.0"# This should be your current semver versionFor more information visit commitizen's configuration page
name: Bump versionon: push: branches: - masterjobs: bump_version: if: "!startsWith(github.event.head_commit.message, 'bump:')"runs-on: ubuntu-latestname: "Bump version and create changelog with commitizen"steps: - name: Check outuses: actions/checkout@v5with: fetch-depth: 0token: "${{secrets.GITHUB_TOKEN }}" - id: czname: Create bump and changeloguses: commitizen-tools/commitizen-action@masterwith: github_token: ${{secrets.GITHUB_TOKEN }} - name: Print Versionrun: echo "Bumped to version ${{steps.cz.outputs.version }}"| Name | Description | Default |
|---|---|---|
github_token | Token for the repo. Can be passed in using ${{secrets.GITHUB_TOKEN }}. Required if push: true | - |
working_directory | Change to this directory before running | repo root directory |
dry_run | Run without creating commit, output to stdout | false |
repository | Repository name to push. Default or empty value represents current github repository | current one |
branch | Destination branch to push changes | Same as the one executing the action by default |
prerelease | Set as prerelease{alpha,beta,rc} choose type of prerelease | - |
extra_requirements | Custom requirements, if your project uses a custom rule or plugins, you can specify them separated by a space. E.g: 'commitizen-emoji conventional-JIRA' | - |
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. Example: body.md | - |
git_redirect_stderr | Redirect git output to stderr. Useful if you do not want git output in your changelog | false |
git_name | Name used to configure git (for git operations) | github-actions[bot] |
git_email | Email address used to configure git (for git operations) | github-actions[bot]@users.noreply.github.com |
push | Define if the changes should be pushed to the branch. | true |
merge | Define if the changes should be pushed even on the pull_request event, immediately merging the pull request. | false |
commit | Define if the changes should be committed to the branch. | true |
commitizen_version | Specify the version to be used by commitizen. Eg: 4.10.0 | latest |
changelog | Create changelog when bumping the version | true |
no_raise | Don't raise the given comma-delimited exit codes (e.g., no_raise: '20,21'). Use with caution! Open an issue in commitizen if you need help thinking about your workflow. | 21 |
increment | Manually specify the desired increment{MAJOR,MINOR, PATCH} | - |
check_consistency | Check consistency among versions defined in commitizen configuration and version_files | 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) | false |
debug | Prints debug output to GitHub Actions stdout | false |
| Name | Description |
|---|---|
version | The next version (same as next_version, kept for historical purposes) |
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 |
The new version is also available as an environment variable under REVISION or you can access using ${{steps.cz.outputs.version }}
- Create a deploy key (which is the SSH public key)
- Add the private key as a Secret in your repository, e.g:
COMMIT_KEY - Set up your action
name: Bump versionon: push: branches: - mainjobs: bump-version: if: "!startsWith(github.event.head_commit.message, 'bump:')"runs-on: ubuntu-latestname: "Bump version and create changelog with commitizen"steps: - name: Check outuses: actions/checkout@v3with: fetch-depth: 0ssh-key: "${{secrets.COMMIT_KEY }}" - name: Create bump and changeloguses: commitizen-tools/commitizen-action@masterwith: push: false - name: Push using sshrun: | git push origin main --tagsname: Bump versionon: push: branches: - mainjobs: bump-version: if: "!startsWith(github.event.head_commit.message, 'bump:')"runs-on: ubuntu-latestname: "Bump version and create changelog with commitizen"steps: - name: Check outuses: actions/checkout@v3with: fetch-depth: 0token: "${{secrets.PERSONAL_ACCESS_TOKEN }}" - name: Create bump and changeloguses: commitizen-tools/commitizen-action@masterwith: github_token: ${{secrets.PERSONAL_ACCESS_TOKEN }}changelog_increment_filename: body.md - name: Releaseuses: softprops/action-gh-release@v1with: body_path: "body.md"tag_name: ${{env.REVISION }}env: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN }}This problem occurs because secrets.GITHUB_TOKEN do not trigger other actions by design.
To solve it, you must use a personal access token in the checkout and the commitizen steps.
Follow the instructions in commitizen's documentation.
Alternatively, you can try using the gh cli in your github action:
gh workflow run <workflow.yaml> ...If your rules can be parsed, then you can build your own commitizen rules, create a new commitizen python package, or you can describe it on the toml config itself.