Skip to content

[BUG](ci) Fix release title format - #716

Merged
John McCall (lowlydba) merged 1 commit into
mainfrom
lowlydba-fix-release-title-format
Sep 4, 2026
Merged

John McCall (lowlydba) merged 1 commit into
mainfrom
lowlydba-fix-release-title-format

Conversation

@lowlydba

@lowlydba John McCall (lowlydba) commented Sep 2, 2026 •

Copy link
Copy Markdown
Contributor

Description

create-package-release titled every 2.0.0 release `<package>` 2.0.0, backticks included, since release titles aren't rendered as markdown. Titles are now <package> v<version>, and a release with a vanity tag takes that tag as its title so the umbrella series stays v1.18.0 -> v2.0.0.

The 13 live 2.0.0 releases were already retitled by hand with gh release edit; this makes the action match. The title is pure gh meta, not the actual tag name.

Fixes #715

Reference

  1. Releases page, showing the retitled 2.0.0 set.

Testing

Shell-only change to a composite action; no unit coverage exists for it. The dry-run step summary now prints the computed title so the next release run shows it before anything is created.

Checklist

  1. Add relevant examples.
  2. Add relevant counterexamples.
  3. Update any counterexamples that became obsolete.
  4. Update in-schema documentation using plain English written in complete sentences, if an update is required.
  5. Update Docusaurus documentation, if an update is required.
  6. Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation.

…by vanity tag

Fixes #715

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Signed-off-by: John McCall <john@overturemaps.org>
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

🗺️ Schema reference docs preview is live!

🌍 Preview https://staging.overturemaps.org/schema/pr/716/schema/index.html
🕐 Updated Sep 02, 2026 22:34 UTC
📝 Commit 096b2af
🔧 env SCHEMA_PREVIEW true

Note

♻️ This preview updates automatically with each push to this PR.

@lowlydba
John McCall (lowlydba) marked this pull request as ready for review September 2, 2026 22:37
@lowlydba
John McCall (lowlydba) requested a review from a team as a code owner September 2, 2026 22:37
Copilot AI lite review requested due to automatic review settings September 2, 2026 22:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The changes are small, consistent with the PR description, and limited to release metadata/title formatting plus corresponding documentation updates.

Pull request overview

This PR fixes GitHub Release title formatting produced by the create-package-release composite action, aligning titles with how GitHub actually displays them (no markdown rendering) and keeping the umbrella overture-schema releases visually continuous via the legacy bare v<version> series.

Changes:

  • Update release title generation to use <package> v<version>, and use the vanity tag (e.g., v2.0.0) as the title when a legacy bare tag is also created.
  • Enhance the dry-run step summary to print the computed release title.
  • Update versioning documentation to reflect the corrected release-title scheme and the continued bare-tag series (… v1.18.0).
File summaries
File Description
docs/versioning.md Updates documented tag/title scheme and clarifies umbrella release titling for legacy bare tags.
.github/actions/create-package-release/action.yml Computes correct gh release create --title value and surfaces it in dry-run output.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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.

Nice

@lowlydba
John McCall (lowlydba) merged commit b646b9c into main Sep 4, 2026
34 of 36 checks passed
@lowlydba
John McCall (lowlydba) deleted the lowlydba-fix-release-title-format branch September 4, 2026 18:19

This branch was successfully deployed

1 active deployment
staging — 096b2af6 Deployed Sep 2, 2026 by lowlydba via Deploy #492
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG](ci) Release titles carry backticks and drop the vanity v prefix

4 participants