Skip to main content

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

Project description

Intro

What is it

cz-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_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]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cz_convention-2.0.1.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

cz_convention-2.0.1-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file cz_convention-2.0.1.tar.gz.

File metadata

  • Download URL: cz_convention-2.0.1.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for cz_convention-2.0.1.tar.gz
Algorithm Hash digest
SHA256 2befa460e15d47b2de39152d61e0fb705985390c6bce70e85d87796e8c9380a6
MD5 7cf1fcec9828f87b452087bc534fed3b
BLAKE2b-256 eab8168cedb228ed0999d0443230f1892bd8aca6866462bff0fd3720ef97ab74

See more details on using hashes here.

File details

Details for the file cz_convention-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cz_convention-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d949702f2ac9fd8ee02955417686d190b948b12dddf97d7c1d62cfe916bb0e31
MD5 aefcf0d56e150726ca07b1da68e437d8
BLAKE2b-256 b5934a5ea153d8e3f0f926ae2355b01558ad865dafcda3f3de6b81d14ff66cc2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page