Skip to main content

Reusable changelog management toolkit for Tenzir repositories.

Project description

📝 tenzir-changelog

tenzir-changelog is the reusable changelog companion for Tenzir projects. It helps contributors capture entries, maintain release manifests, and ship tidy change logs across public and private repositories.

✨ Highlights

  • 🚀 Bootstrap a changelog project with sensible defaults and YAML configuration in seconds.
  • 🧾 Capture changelog entries via an interactive assistant that pulls metadata from Git and GitHub, pre-filling authors from your gh login and current PRs.
  • 📦 Assemble release manifests that include narrative introductions before the structured list of entries.
  • 🔍 Validate entry metadata and release manifests to keep docs tooling happy.

📦 Installation

tenzir-changelog ships on PyPI. Use uvx to fetch and execute the latest compatible version on demand (requires Python 3.12+):

uvx tenzir-changelog --help

uvx downloads the newest release, runs it in an isolated environment, and caches the result for snappy subsequent invocations.

📚 Documentation

Consult our user guide for an end-to-end walkthrough of maintaining changelogs.

We also provide a dense reference that explains concepts, abstractions, and CLI details.

🐶 Dogfooded Project

The repository ships with changelog/, the real changelog project maintained by the Tenzir team. Explore it to see how config.yaml, unreleased/, and Markdown release manifests fit together end-to-end.

🤝 Contributing

Want to contribute? We're all-in on agentic coding with Claude Code! The repo comes pre-configured with our custom plugins—just clone and start hacking.

📄 License

tenzir-changelog is released under the Apache License, Version 2.0. Consult LICENSE for the full text.

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

tenzir_changelog-0.18.0.tar.gz (83.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tenzir_changelog-0.18.0-py3-none-any.whl (53.8 kB view details)

Uploaded Python 3

File details

Details for the file tenzir_changelog-0.18.0.tar.gz.

File metadata

  • Download URL: tenzir_changelog-0.18.0.tar.gz
  • Upload date:
  • Size: 83.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tenzir_changelog-0.18.0.tar.gz
Algorithm Hash digest
SHA256 4b18744edc787571a27d328820e43266c0febde3f14a3b56ee7b2f1902b72e30
MD5 3f3a1750cd7ad601896fe5c4762b57d7
BLAKE2b-256 04e880a50a02791c00a4b5ef43b58bf7866199b4558a3cf7cbd534c3af919bb7

See more details on using hashes here.

Provenance

The following attestation bundles were made for tenzir_changelog-0.18.0.tar.gz:

Publisher: publish.yaml on tenzir/changelog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tenzir_changelog-0.18.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tenzir_changelog-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d1dadedf4c32d417e3df5a4185ad7ccccd8641718db7e9693ea6e5af61ebe2c1
MD5 fd695c7237b2d9a2e6a820fca5a7955a
BLAKE2b-256 f9f88e374484373d25205bc8923bed5ce3c6ed9a1cb869e579077b4c3e839219

See more details on using hashes here.

Provenance

The following attestation bundles were made for tenzir_changelog-0.18.0-py3-none-any.whl:

Publisher: publish.yaml on tenzir/changelog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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