Skip to content

Send readers to the tags, which is where the versions are - #39

Merged
mbakalarski merged 1 commit into
mainfrom
fix-install-version-link
Aug 6, 2026
Merged

Send readers to the tags, which is where the versions are#39
mbakalarski merged 1 commit into
mainfrom
fix-install-version-link

Conversation

@mbakalarski

Copy link
Copy Markdown
Member

docs/install.md told readers to "pick a version from the Releases page" and
linked there. This repository has no GitHub Releasesrelease.yml builds
the package and pushes it to GHCR and Upbound, and never creates one — so that
page answers "There aren't any releases here", while four tags (v0.4.0,
v0.3.0, v0.2.15, v0.2.14) sit next to it.

Reported from the published page.

The fix follows what the sentence beside the link already claimed — the git tag
is the package version
— so the link now goes to
/tags, and the comment in the
snippet says "the newest tag" rather than naming the Releases page again.

Verified: the tags page returns 200 and lists every published version, and
mkdocs build --strict passes.

Not done here

Creating actual GitHub Releases is the other way to resolve this, and it is a
larger decision rather than a link fix — it would mean backfilling four tags and
adding a step to release.yml. Worth considering separately, since release
notes are wanted anyway: the spec.scope immutability hazard and "a raised
dependsOn floor does not upgrade an installed dependency" are both things a
consumer should meet at upgrade time, and A5's Marketplace listing wants a
release-notes/ directory too.

🤖 Generated with Claude Code

install.md pointed at the Releases page to pick a version. There are no
GitHub Releases in this repository -- release.yml builds the package and
pushes it to both registries, and never creates one -- so that page answers
"There aren't any releases here" while four tags sit next to it.

The sentence beside the link already said where to look: the git tag is the
package version.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mbakalarski
mbakalarski merged commit 3053d3c into main Aug 6, 2026
3 checks passed
@mbakalarski
mbakalarski deleted the fix-install-version-link branch August 6, 2026 12:35
mbakalarski added a commit that referenced this pull request Aug 6, 2026
The deploy job waits on GitHub's Pages backend and does no work of its own,
so nothing here bounds how long it takes. A 10 minute cap killed PR #39's
deploy at 10m03s: the change was merged, every check was green, and the
published page kept serving the old content with nothing to indicate why.

Measured the same day on netclab.github.io, which runs the same shape of
workflow: 8m04s, a cancellation at 10m00s, then 9m12s. The successful runs
sit just under the cap that killed one, which is how this stays invisible
until it is not.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
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.

1 participant