https://github.com/commitizen-tools/setup-cz

Github action to configure cz cli
https://github.com/commitizen-tools/setup-cz

commitizen github-actions

Last synced: 23 days ago
JSON representation

Github action to configure cz cli

• Host: GitHub
• URL: https://github.com/commitizen-tools/setup-cz
• Owner: commitizen-tools
• License: mit
• Created: 2025-11-20T06:47:35.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2026-01-12T16:13:22.000Z (2 months ago)
• Last Synced: 2026-02-13T07:29:32.568Z (about 1 month ago)
• Topics: commitizen, github-actions
• Homepage:
• Size: 44.9 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# setup-cz

This workflow sets up the commitizen CLI for use in your GitHub workflows.

Unlike `commitizen-action`, this workflow only installs the CLI.

It does not automatically bump, commit or push changes.

This workflow, instead, gives more flexibility to the user by letting them

use the full range of commitizen commands.

## Usage

```yaml

jobs:

  bump:

    runs-on: ubuntu-latest

    permissions:

      contents: write

      actions: write

    steps:

      - uses: actions/checkout@v6

        with:

          fetch-depth: 0

          fetch-tags: true

      - uses: commitizen-tools/setup-cz@main

        with:

          python-version: "3.x"

      - run: |

          cz version -p

          cz bump --yes --annotated-tag

          git push --follow-tags

```

## Inputs

|Input|Description|Default|Required|

|-----|-----------|-------|:------:|

|`version`|Version of commitizen to install|`latest`|no|

|`extra_requirements`|Install extra dependencies|n/a|no|

|`python-version`|Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset. Passed directly to setup-python|n/a|no|

|`set-git-config`|Set git config|`true`|no|

## Outputs

None