Skip to content

commitizen-tools/commitizen-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

commitizen-action

Commitizen github action to bump and create changelog

Usage

  1. In your repository create a .cz.toml file (you can run cz init to create it)
  2. Create a .github/workflows/bumpversion.yaml with the Sample Workflow

Sample Workflow

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@v2with: fetch-depth: 0 - name: Create bump and changeloguses: commitizen-tools/commitizen-action@masterwith: github_token: ${{secrets.GITHUB_TOKEN }}

Variables

NameDescriptionDefault
github_tokenToken for the repo. Can be passed in using ${{secrets.GITHUB_TOKEN }} required-
dry_runRun without creating commit, output to stdoutfalse
repositoryRepository name to push. Default or empty value represents current github repository (${GITHUB_REPOSITORY})current one
branchDestination branch to push changesmaster

If you use secrets.GITHUB_TOKEN other actions won't be triggered. To solve that you will need a personal access token. Follow the instructions of github tutorial in order to create one

About

Commitizen github action to bump and create changelog

Resources

License

Stars

Watchers

Forks

Contributors 27