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

  • User Reference: Concise description of concepts and abstractions.
  • Development guide: Local workflows, quality gates, and release procedures for maintainers.

🐶 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.

📄 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.9.1.tar.gz (66.8 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.9.1-py3-none-any.whl (48.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tenzir_changelog-0.9.1.tar.gz
  • Upload date:
  • Size: 66.8 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.9.1.tar.gz
Algorithm Hash digest
SHA256 71e7d48c776e891a88cddfa55e114a2e8d4edd5369f35f50f5b5aecf83dcc68f
MD5 59d837b63eecef12401294a18dcfe891
BLAKE2b-256 be4afcea0dff0c179fe67c890329a99a102f6fdd1f3e69aafa8478b527bd2077

See more details on using hashes here.

Provenance

The following attestation bundles were made for tenzir_changelog-0.9.1.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.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for tenzir_changelog-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b4853f226884f619a9cb0f91e6bafee3e985fc068ad869a394044d7181133a6b
MD5 227812c146c4534876970cf4b91d93c1
BLAKE2b-256 028f1c1c6c9a4489d9a12c6a7d57e8f37d82eaceef471d445568ed8887a6f13f

See more details on using hashes here.

Provenance

The following attestation bundles were made for tenzir_changelog-0.9.1-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