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.0.tar.gz (66.3 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.0-py3-none-any.whl (48.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tenzir_changelog-0.9.0.tar.gz
  • Upload date:
  • Size: 66.3 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.0.tar.gz
Algorithm Hash digest
SHA256 2b63570b5c5c60102598430e018053e3a6910b1f0667f4256d6457a75a214696
MD5 9494fca611ad8957ea50862bb2fb7c89
BLAKE2b-256 726fac47c97018d41d278f911badfa0664923d91f68f71c2b386cb5fbfaeedc8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for tenzir_changelog-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f80e100371d7582ff3bf85058d1bb8410cf23b58e941fc48bd8cf518e52499a9
MD5 bd20ea7e1a2530eab9c1d167f86c989a
BLAKE2b-256 8ffe20b9af411654abdbac01594d467849a519128604139d4022c293ebee4d5e

See more details on using hashes here.

Provenance

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