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 workspace with sensible defaults and YAML configuration in seconds.
  • 🧾 Capture changelog entries via an interactive assistant that pulls metadata from Git and GitHub.
  • 📦 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 guide — CLI walkthroughs, configuration concepts, and a hands-on tutorial.
  • Development guide — local workflows, quality gates, and release procedures for maintainers.

🧪 Example

The repository ships with example-changelog/, a fully bootstrapped workspace that mirrors the tutorial in DOCUMENTATION.md. Explore it to see how config.yaml, entries/, 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.1.0.tar.gz (24.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.1.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tenzir_changelog-0.1.0.tar.gz
  • Upload date:
  • Size: 24.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.1.0.tar.gz
Algorithm Hash digest
SHA256 1ec5b43c1a485cb6012ce8627d203365785a28d9a80235bdc1b28e6ccf14cf37
MD5 7ca6d097e3d9346b27c457f028b845fb
BLAKE2b-256 ca5301ec2aad78c95fd09103ecccbe10183e6deda567e1b6646a640e22570a73

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for tenzir_changelog-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f616da5952f2061aa4f3c9ce1c3e45af4206e8895d61beacba49aafd71999d1
MD5 a2c4968101a0bb94b164e64d28141c4e
BLAKE2b-256 2895f87f534bd18611e37d537f5f6296b99bc786050bce9c735b75a8c15d5fd9

See more details on using hashes here.

Provenance

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