cz-convention 2.0.0

Extend the commitizen tools to create conventional commits and CHANGELOG that link to git providers.

Intro

What is it

cz-github-convention is a plugin for commitizen

What it do

Create links to commits & author info in the CHANGELOG.md

Installation

pip install cz-convention
cz init

Config sample

cz.json

{
  "commitizen": {
    "name": "cz_github_convention",
    "version": "0.0.1",
    "tag_format": "v$version",
    "git_provider": "github",
    "repo_url": "https://github.com/superman/super-project"
  }
}

.pre-commit-config.yaml

repos:
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v2.38.0
    hooks:
      - id: commitizen
        stages: [commit-msg]
        additional_dependencies: [cz-convention]