Skip to content

GitHub release title formatting

Choose a tag to compare

@tenzir-github-app tenzir-github-app released this 07 Jul 04:29
v1.11.0
457e8f4

This release improves GitHub release titles by including the project name, version, and release title by default. It keeps untitled releases clean while allowing custom title formats through the CLI and Python API.

🚀 Features

GitHub release title formatting

The release publish command now formats GitHub release titles as PROJECT VERSION: TITLE by default when the release has a title:

tenzir-ship release create v1.2.3 --title "Faster ingest"
tenzir-ship release publish v1.2.3
# GitHub release title: "Tenzir Ship v1.2.3: Faster ingest"

When the release has no title, release create leaves the manifest title absent and GitHub receives PROJECT VERSION without the trailing : TITLE segment:

tenzir-ship release create v1.2.3
tenzir-ship release publish v1.2.3
# GitHub release title: "Tenzir Ship v1.2.3"

This keeps the release manifest title focused on the release itself while making GitHub release pages show the project and version more clearly. To customize the GitHub title, pass a format string to release publish --title or Changelog.release_publish(title=...):

tenzir-ship release publish v1.2.3 --title '[$PROJECT $VERSION] $TITLE'
# GitHub release title: "[Tenzir Ship v1.2.3] Faster ingest"

The $PROJECT, $VERSION, and $TITLE variables are optional. A plain string without variables overrides the GitHub title literally:

tenzir-ship release publish v1.2.3 --title "Faster ingest"
# GitHub release title: "Faster ingest"

By @IyeOnline, @mavam, and @codex in #38.