Skip to content

docs(readme): fix release badge to use GitHub releases, not raw tags - #2441

Merged
jfallows merged 2 commits into
developfrom
claude/buildcache-zilla-packages-jph7rt
Aug 27, 2026
Merged

docs(readme): fix release badge to use GitHub releases, not raw tags#2441
jfallows merged 2 commits into
developfrom
claude/buildcache-zilla-packages-jph7rt

Conversation

@jfallows

Copy link
Copy Markdown
Contributor

Description

The README's "release" badge used github/v/tag/aklivity/zilla, which reads from raw git tags. This repo's git-flow release process tags every version, including in-progress release candidates (e.g. 2.4.0-rc1 through 2.4.0-rc20a), so the badge could show an unreleased rc as the "release" instead of the latest finished version.

Switched to github/v/release/aklivity/zilla, which reads from actual GitHub Release objects. This repo's release workflow already skips creating a Release for pre-release versions (confirmed: the repo's Releases list contains only real x.y.z versions, no rc's), so this endpoint structurally can't surface an unfinished rc. Also pinned sort=semver explicitly, since this repo releases patches on support/N.x branches independently of develop — a newer-dated patch release on an older support branch should not outrank a higher-versioned release on the mainline.


Generated by Claude Code

github/v/tag pulls from all git tags, which include in-progress rc
tags (e.g. 2.4.0-rc20a), so the badge could show an unreleased
release candidate as "release". Switch to github/v/release, which
only reflects actual GitHub Release objects; this repo's release
workflow already skips creating a Release for pre-release versions,
so this endpoint can never surface an rc. Pin sort=semver so a
newer-dated patch release on a support/N.x branch doesn't outrank a
higher-versioned release on the mainline.
Ports: b6e8c5f

Partial port: support/1.x's fix (#2442) additionally scopes the badge
to filter=1.* since that branch's README tracks the 1.x line
specifically, while this branch's badge should reflect the repo's
overall highest release. Same root fix (github/v/tag -> github/v/release
+ sort=semver), genuine content difference in the filter, so
subject/patch matching won't bridge it -- add the merge-ignore entry
so gitflow-changelog doesn't flag #2442 as an unported gap.

@jfallows jfallows left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

LGTM

@jfallows
jfallows merged commit 90e8a97 into develop Aug 27, 2026
3 checks passed
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