cz-keep-a-changelog-plugin 0.0.5

Full compliance of Commitizen with Keep a Changelog

Commitizen - Keep a Changelog-Plugin

Adds full compliance of Commitizen with Keep a Changelog v1.1.0.

Features

• Complete map of Conventional Commits-types to Keep a Changelog-types of changes:
  • feat: Added
  • fix: Fixed
  • perf: Changed
  • refactor: Changed
  • revert: Removed
• Enables to replace issue numbers in the changelog by a markdown link to the issue:
  #123 -> [#123](https://github.com/user/repo/issues/123)
• Keep a Changelog-like header for changelog file.

Installation

Using pip:

# Install
pip install cz_keep_a_changelog_plugin

# Keep it updated
pip upgrade cz_keep_a_changelog_plugin

Using uv:

# Install
uv install cz_keep_a_changelog_plugin

# Keep it updated
uv upgrade cz_keep_a_changelog_plugin

Usage

Configuration

In the project's pyproject.toml set:

...

[tool.commitizen]
name = "cz_keep_a_changelog_plugin"

Pre-Commit

To use in pre-commit, add this to your pre-commit-config.yml. Run pre-commit autoupdate to get the latest version:

repos:
  - repo: https://github.com/commitizen-tools/commitizen
    rev: main
    hooks:
      - id: commitizen
        additional_dependencies: [cz_keep_a_changelog_plugin]
        stages: [commit-msg]
      - id: commitizen-branch
        additional_dependencies: [cz_keep_a_changelog_plugin]
        stages: [pre-push]

Additional Settings

In the project's pyproject.tomlset the issue_url_template where {{issue}} will be replaced by the issue number:

...

[tool.commitizen]
name = "cz_keep_a_changelog_plugin"
...

[tool.commitizen.cz_keep_a_changelog_plugin]
issue_url_template = "https://cola5.github.io/cz-keep-a-changelog-plugin/issues/{{issue}}"