Skip to content

README.md

Latest commit

 

History

History
41 lines (37 loc) · 1.17 KB

README.md

File metadata and controls

41 lines (37 loc) · 1.17 KB

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

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

Outputs

None