Skip to content

Tool repo READMEs have hardcoded version-X.Y.Z badges that drift on each release #54

@TMHSDigital

Description

@TMHSDigital

Summary

Tool repo READMEs include a hardcoded version-X.Y.Z badge that drifts on every release. The dynamic shields.io/github/v/release badge that sits next to it already shows the same data, making the hardcoded badge redundant and a maintenance burden.

Two options

Option A (drop the static badge): one-line change per repo, ships immediately, eliminates the drift entirely. The dynamic badge already conveys the same information.

Option B (extend release-doc-sync): add badge URL rewriting to release-doc-sync@v1 alongside the existing CLAUDE.md / ROADMAP.md / CHANGELOG.md rewrites. Keeps the static badge functional, benefits all consumers including the meta-repo and any future tool repos. Requires meta-repo work and a coordinated rollout.

Recommendation

Option A. The drift is real, the dynamic badge already exists, and the meta-repo work for Option B is more scope than the cosmetic benefit justifies. Cross-repo PR shipping the badge removal is a small canary-then-parallel session (similar to DTD#46).

Surfaced during

Blender-Developer-Tools v0.2.0 audit. The badge had drifted from 0.1.1 to 0.2.0 across 4 releases without any release-doc-sync involvement.

Out of scope

  • Other repos that may have similar hardcoded badges in CLAUDE.md or AGENTS.md (none observed, but worth a sweep if Option A wins)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions