Skip to content

docs: fix stale v1.0.0 references after the 1.0.1 release#40

Merged
Shu-Wan merged 1 commit into
mainfrom
docs/fix-stale-version-refs
Jun 16, 2026
Merged

docs: fix stale v1.0.0 references after the 1.0.1 release#40
Shu-Wan merged 1 commit into
mainfrom
docs/fix-stale-version-refs

Conversation

@Shu-Wan

@Shu-Wan Shu-Wan commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Post-release cleanup of v1.0.0 references the 1.0.1 release (#39) didn't touch. Docs-only — the published v1.0.1 tag/release is unaffected.

Fixes

  • README — the "current release v1.0.0" bullet was hardcoded. De-hardcoded to point at the dynamic Release badge, so it can't go stale again.
  • CHANGELOG footer — the link-reference definitions still had [Unreleased]: …compare/v1.0.0…HEAD and no [1.0.1] target, which left the ## [1.0.1] heading as a dead link. Repointed [Unreleased] to v1.0.1…HEAD and added [1.0.1]: …/releases/tag/v1.0.1.
  • release.yml — the workflow_dispatch example tag is now generic (v1.2.3) instead of v1.0.0.
  • DEVELOPMENT.md — added the two release-checklist steps that were missed this round (update the CHANGELOG link-reference footer; bump coverage.md's **Version:** line) and noted the README version is now dynamic.

Why these were missed

The release checklist (step 4) covered moving the [Unreleased] heading but not the footer link definitions or the README/coverage version lines — so they drifted. The DEVELOPMENT.md change closes that gap for next time.

🤖 Generated with Claude Code

- README 'current release' bullet was hardcoded to v1.0.0 — de-hardcode
  it to point at the dynamic Release badge so it never goes stale again.
- CHANGELOG link-reference footer still pointed [Unreleased] at v1.0.0
  and had no [1.0.1] target (leaving the new ## [1.0.1] heading a dead
  link) — repoint [Unreleased] to v1.0.1...HEAD and add the [1.0.1] tag.
- release.yml workflow_dispatch example: generic v1.2.3, not v1.0.0.
- DEVELOPMENT.md release checklist: add the CHANGELOG-footer + coverage
  version-line steps that were missed this release, and note the README
  version is now dynamic.

Docs-only; the published v1.0.1 release/tag is unaffected.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Shu-Wan Shu-Wan merged commit d734cb9 into main Jun 16, 2026
3 checks passed
@Shu-Wan Shu-Wan deleted the docs/fix-stale-version-refs branch June 16, 2026 00:12
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