𝗰𝗼𝗺𝗺𝗶𝘁𝗶𝘇𝗲𝗻-𝚜𝚙𝚍𝚡-𝓬𝓱𝓪𝓷𝓰𝓮𝓵𝓸𝓰
A commitizen changelog format plugin with YAML frontmatter awareness —
designed for REUSE/SPDX-compliant changelogs. No more false version detection
from license headers like Apache-2.0.
Warning: This project is in early development.
Features
- SPDX-aware — strips
----delimited YAML frontmatter before parsing - Correct version detection — no false positives from
Apache-2.0style headers - Drop-in replacement — extends commitizen's built-in
Markdownformat - Zero extra config — just set
changelog_format = "spdx-markdown"
Why do I need this?
If you keep your changelog in docs/changelog.md instead of the project root,
placing it alongside your documentation lets readers of your published site who
might not directly browse the git repository stay informed about recent changes.
Documentation generators like Zensical, Docusaurus, and tools using Google's
Open Knowledge Format (OKF) require a YAML front matter for meta data.
When you apply a REUSE/SPDX license header with reuse annotate, the
header lands as a YAML comment inside the front matter, not as an HTML comment:
# SPDX-License-Identifier: Apache-2.0
The catch: commitizen's built-in Markdown format does not understand YAML
front matter. It reads Apache-2.0 as a version number, causing
cz bump --changelog to fail silently or produce wrong results.
This plugin strips the front matter before parsing, so your changelog stays compliant, doc-generator-friendly, and commitizen-compatible — all at once.
Getting started
Installation
uv add commitizen-spdx-changelog
# or: pip install commitizen-spdx-changelog
See the docs landing page for a full overview, and the usage guide for furher setup and workflow instructions.
Configuration
In pyproject.toml:
[tool.commitizen]
changelog_format = "spdx-markdown"
Usage
cz bump --changelog
The plugin handles changelogs with SPDX frontmatter like:
---
# SPDX-FileCopyrightText: 2026 Pablo Hörtner <redtux@pm.me>
#
# SPDX-License-Identifier: Apache-2.0
icon: lucide/git-commit-vertical
---
# Changelog
## 0.4.0 (2026-06-08)
...
Development
direnv allow
uv sync --group dev
Running direnv allow will activate the devbox environment automatically. See
the Devbox guide for all available commands and tools.
Contributing
Bug reports, feature requests, and pull requests are welcome.
See docs/contributing.md for guidelines.
For documentation contributions, please follow these principles:
Write for humans, keep it minimal, update docs with code, delete dead content.
Every page in docs/ and the project README.md are held to these standards.
License
Distributed under the terms of the Apache License 2.0.
- Copyright © 2026 Pablo Hörtner
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file commitizen_spdx_changelog-0.1.3.tar.gz.
File metadata
- Download URL: commitizen_spdx_changelog-0.1.3.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c2b0be5c000dd7f758f9ce9df6bcb3ab1721e91e28bcad619f59e243382fc23
|
|
| MD5 |
2ebc545c65ca815cd613bd34e993ae3e
|
|
| BLAKE2b-256 |
1ae0d441549b8cf2c2bace541ea80f638d60d5f80cf336213a69a35872570d9b
|
Provenance
The following attestation bundles were made for commitizen_spdx_changelog-0.1.3.tar.gz:
Publisher:
publish.yaml on redtux/commitizen-spdx-changelog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
commitizen_spdx_changelog-0.1.3.tar.gz -
Subject digest:
5c2b0be5c000dd7f758f9ce9df6bcb3ab1721e91e28bcad619f59e243382fc23 - Sigstore transparency entry: 1937615101
- Sigstore integration time:
-
Permalink:
redtux/commitizen-spdx-changelog@7bff896e19c1ab164821caf8c4f3cf593a800717 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/redtux
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@7bff896e19c1ab164821caf8c4f3cf593a800717 -
Trigger Event:
push
-
Statement type:
File details
Details for the file commitizen_spdx_changelog-0.1.3-py3-none-any.whl.
File metadata
- Download URL: commitizen_spdx_changelog-0.1.3-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ecf1d6d59a6c406f5b76de8e2d3cfbbdab5eda6929a012b9e730bdc478a7846
|
|
| MD5 |
0444995729d97539d6391cb57a41744e
|
|
| BLAKE2b-256 |
bdf31a203a46f7350f5eaf034c0d9d7c3be510950614466aca803cba973745d0
|
Provenance
The following attestation bundles were made for commitizen_spdx_changelog-0.1.3-py3-none-any.whl:
Publisher:
publish.yaml on redtux/commitizen-spdx-changelog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
commitizen_spdx_changelog-0.1.3-py3-none-any.whl -
Subject digest:
5ecf1d6d59a6c406f5b76de8e2d3cfbbdab5eda6929a012b9e730bdc478a7846 - Sigstore transparency entry: 1937615193
- Sigstore integration time:
-
Permalink:
redtux/commitizen-spdx-changelog@7bff896e19c1ab164821caf8c4f3cf593a800717 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/redtux
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@7bff896e19c1ab164821caf8c4f3cf593a800717 -
Trigger Event:
push
-
Statement type:
