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.8.1.tar.gz (64.0 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.8.1-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tenzir_changelog-0.8.1.tar.gz
  • Upload date:
  • Size: 64.0 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.8.1.tar.gz
Algorithm Hash digest
SHA256 2f39c60a644c6cbde0344f58b67ce7697df679491b5fb41a87a2fe811a7f1430
MD5 cd99ce495a6b343aa6e1691aa1528eb4
BLAKE2b-256 7fb6cdac468c1542f5634a5bb4eeacfee5d9bfab74941dd75237d00f36868236

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for tenzir_changelog-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4105b0b48aef8b85d3cb0fe2f27759f4587f69fc15f17277d2e7efe31f9960ce
MD5 ea708a4c7eee7bac9b9f83530d90e99d
BLAKE2b-256 c6e2c37def7b87fcb503f897b3d58b87eb168504fbe1e0efe7c92f92dfa293b8

See more details on using hashes here.

Provenance

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