Skip to main content

Reusable changelog management toolkit for Tenzir repositories.

Project description

🚀 tenzir-ship

tenzir-ship helps you ship faster with automated release engineering. Manage changelogs, generate release notes, and publish GitHub releases.

✨ Highlights

  • 📝 Changelog management: Capture entries via an interactive assistant that pulls metadata from Git and GitHub, pre-filling authors and PR references.
  • 📦 Release notes: Generate release notes from structured entries, ready for documentation pipelines or direct publishing.
  • 🚀 GitHub releases: Publish releases directly to GitHub with generated notes and assets.
  • 🔖 Opinionated versioning: Release manifests and package files use bare semantic versions such as 1.2.3, while Git and GitHub releases are tagged as v1.2.3.
  • 🔧 CLI and Python API: Use the command line for interactive workflows or the Python API for automation.

📦 Installation

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

uvx tenzir-ship --help

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

🤖 Agent Skill

Install the skill via Vercel Skills:

npx skills add tenzir/ship

🛠️ Reusable GitHub Actions workflow

This repository ships a reusable release workflow at .github/workflows/release.yaml. External repositories can call it directly. Pin the workflow to a released tag or full commit SHA instead of a moving branch name.

jobs:
  release:
    uses: tenzir/ship/.github/workflows/release.yaml@<pinned-ref>
    permissions:
      contents: write
    with:
      intro: This release improves parser coverage and fixes packaging.
      bump: auto

The workflow supports GitHub App tokens, static push tokens, GPG signing, pre/post hooks, and several release-control options. See the reference for the full list of inputs, secrets, and auth modes.

📚 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-ship 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_ship-1.7.4.tar.gz (141.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_ship-1.7.4-py3-none-any.whl (89.7 kB view details)

Uploaded Python 3

File details

Details for the file tenzir_ship-1.7.4.tar.gz.

File metadata

  • Download URL: tenzir_ship-1.7.4.tar.gz
  • Upload date:
  • Size: 141.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tenzir_ship-1.7.4.tar.gz
Algorithm Hash digest
SHA256 838ee6503a7cfebbd1af7eff435c8a0074d7d6035f6cf53ec9f38341b71efd07
MD5 91020b57f49a29184716661af3902cc5
BLAKE2b-256 b7561a87abe0617fcc1ff1a9c68f3aa252ac9858708abc57b4d6dc78135007bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for tenzir_ship-1.7.4.tar.gz:

Publisher: publish.yaml on tenzir/ship

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_ship-1.7.4-py3-none-any.whl.

File metadata

  • Download URL: tenzir_ship-1.7.4-py3-none-any.whl
  • Upload date:
  • Size: 89.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tenzir_ship-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0a1ea8924a39f2cac90cb007a2a174820eb5568af8c9c1ada143eb30238b9085
MD5 d360cdf8bd344bf8888c53418ff3eb70
BLAKE2b-256 9cd02e1338e7a5a9d0c5c5f38957f5a44368a919b2db2b8d8cd163fbc032b020

See more details on using hashes here.

Provenance

The following attestation bundles were made for tenzir_ship-1.7.4-py3-none-any.whl:

Publisher: publish.yaml on tenzir/ship

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