Skip to content

Format GitHub release titles as PROJECT VERSION: TITLE - #38

Merged
mavam merged 3 commits into
mainfrom
topic/github-release-titles
Jul 7, 2026
Merged

Format GitHub release titles as PROJECT VERSION: TITLE#38
mavam merged 3 commits into
mainfrom
topic/github-release-titles

Conversation

@IyeOnline

@IyeOnline IyeOnline commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

🔍 Problem

  • GitHub shows release tags poorly, so release pages often need titles like Project v1.2.3: Performance improvements.
  • The release manifest title: should stay the release title itself, not the fully composed GitHub presentation title.

🛠️ Solution

  • Rebuilt the branch from origin/main and kept release create --title unchanged.
  • release publish now formats GitHub release titles as $PROJECT $VERSION: $TITLE by default, omitting the title segment for auto-generated/default manifest titles.
  • release publish --title accepts a format string with $PROJECT, $VERSION, and $TITLE placeholders for GitHub-only title customization.
  • Changelog.release_publish(title=...) mirrors the publish-time CLI option.

💬 Review

  • Added CLI and Python API coverage for default formatting, custom formatting, existing-release edits, retry output, and unchanged manifest title storage.
  • Verified with ruff check, ruff format --check, mypy, pytest --durations=10, and tenzir-ship --root changelog validate.
📚 Docs PR: tenzir/content#95

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7a1aee365a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/tenzir_ship/cli/_release.py Outdated
Comment thread src/tenzir_ship/api.py Outdated
@IyeOnline
IyeOnline force-pushed the topic/github-release-titles branch from 2c2c0dc to dc8696f Compare July 6, 2026 14:29

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dc8696f4bf

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/tenzir_ship/cli/_release.py Outdated

@mavam mavam left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think two title flags are good idea. This tool is declarative and adding flags to override is not how the UX is supposed to work, except for very narrow cases. The only new flag we need is to adjust the GitHub release title.

Please also file a companion docs PR update.

Comment thread changelog/unreleased/composed-github-release-titles.md Outdated
Comment thread changelog/unreleased/composed-github-release-titles.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 906a72d3b2

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/tenzir_ship/cli/_release.py Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e579996273

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/tenzir_ship/cli/_release.py Outdated
@IyeOnline
IyeOnline requested a review from mavam July 6, 2026 15:39
Comment thread .github/workflows/release.yaml Outdated
Comment thread .github/workflows/trigger-release.yaml
Comment thread changelog/unreleased/composed-github-release-titles.md Outdated
Comment thread skills/tenzir-ship/references/create-local-release.md Outdated
Comment thread skills/tenzir-ship/references/create-local-release.md Outdated
Comment thread skills/tenzir-ship/references/create-remote-release.md Outdated
Compose GitHub release titles during publish from the project name, release version, and manifest title. Keep release creation and manifest title storage unchanged while adding a publish-time format override for the CLI and Python API.

Assisted-by: GPT-5 (Codex)
@mavam
mavam force-pushed the topic/github-release-titles branch from e579996 to 5c65470 Compare July 6, 2026 18:22
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@mavam mavam changed the title Compose GitHub release titles as PROJECT: VERSION: TITLE Format GitHub release titles as PROJECT VERSION: TITLE Jul 6, 2026
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@mavam
mavam force-pushed the topic/github-release-titles branch from e16d305 to 101f293 Compare July 6, 2026 18:35
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@mavam
mavam force-pushed the topic/github-release-titles branch from 101f293 to 3629c2e Compare July 6, 2026 21:56
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

Expand the changelog entry with examples for placeholder-based formatting and literal GitHub title overrides.

Assisted-by: GPT-5 (Codex)
@mavam
mavam force-pushed the topic/github-release-titles branch from 3629c2e to 5a04554 Compare July 6, 2026 21:57
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

Preserve an absent manifest title as empty release metadata instead of materializing a project/version fallback. GitHub publish now applies the project/version fallback only when composing the release title.

Assisted-by: GPT-5 (Codex)
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@mavam
mavam merged commit 79d9106 into main Jul 7, 2026
9 checks passed
@mavam
mavam deleted the topic/github-release-titles branch July 7, 2026 04:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants