Skip to content

fix: correct tag format and clarify v prefix in README#28

Merged
MantisClone merged 2 commits intomainfrom
fix/readme-tag-format
Mar 13, 2026
Merged

fix: correct tag format and clarify v prefix in README#28
MantisClone merged 2 commits intomainfrom
fix/readme-tag-format

Conversation

@MantisClone
Copy link
Member

@MantisClone MantisClone commented Mar 13, 2026

Summary

  • Tag format in publish procedure says v1.2.0 but we actually use 1.2.0 (no v prefix)
  • Corrected the tag format documentation to match actual usage
  • Added note clarifying that git tags have no v prefix but deployed files on GitHub Pages do (e.g., v1.2.0.json) — the deployment workflow adds the prefix automatically

Test plan

  • Verify README publish procedure matches actual tag format

🤖 Generated with Claude Code

Tags use `1.2.0` format (no `v` prefix), not `v1.2.0` as documented.
The deployed files on GitHub Pages do use the `v` prefix (e.g., `v1.2.0.json`),
but the git tags themselves do not.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@greptile-apps
Copy link

greptile-apps bot commented Mar 13, 2026

Greptile Summary

This PR fixes a documentation inaccuracy in the README.md publish procedure, correcting the git tag format from v1.2.0 to 1.2.0 (no v prefix) to match actual repository usage.

  • The fix is verified correct: all existing git tags in the repo (1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.3.1, 1.3.2) use no v prefix
  • The distinction noted in the PR description is accurate — deployed files on GitHub Pages do use the v prefix (e.g. v1.2.0.json), but git tags and GitHub Releases do not
  • The deploy.yml workflow derives filenames from the tokens/token-list.json version field and prepends v itself, so the release tag format has no effect on deployed artifact naming
  • No code, logic, or workflow changes are included — purely a documentation correction

Confidence Score: 5/5

  • This PR is safe to merge — it is a single-line documentation fix verified against actual repository state.
  • The change is documentation-only, touches no code or workflows, and is confirmed accurate by inspecting the existing git tags (1.0.01.3.2) and the deploy.yml workflow logic.
  • No files require special attention.

Important Files Changed

Filename Overview
README.md Corrects the publish procedure tag format from v1.2.0 to 1.2.0 (no v prefix), accurately reflecting the actual git tag convention used in this repo (1.0.0, 1.1.0, etc.)

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Merge changes to main] --> B[Create GitHub Release]
    B --> C["Set tag = version from tokens/token-list.json\ne.g. 1.2.0 — no 'v' prefix"]
    C --> D[deploy.yml workflow triggered]
    D --> E[Read version from tokens/token-list.json]
    E --> F["Create versioned files with 'v' prefix\ne.g. v1.2.0.json, v1.2.json, v1.json"]
    F --> G["Commit snapshot to versions/\ne.g. versions/v1.2.0.json"]
    G --> H[Deploy dist/ to GitHub Pages]
    H --> I["Available at:\nhttps://.../v1.2.0.json\nhttps://.../latest.json"]
Loading

Last reviewed commit: cc2ab8f

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@MantisClone MantisClone self-assigned this Mar 13, 2026
@MantisClone MantisClone changed the title fix: correct tag format in README publish procedure fix: correct tag format and clarify v prefix in README Mar 13, 2026
@MantisClone MantisClone merged commit 4dc433a into main Mar 13, 2026
1 check passed
@MantisClone MantisClone deleted the fix/readme-tag-format branch March 13, 2026 17:27
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