Skip to content

Commit 4dc433a

Browse files
MantisCloneclaude
andauthored
fix: correct tag format and clarify v prefix in README (#28)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 8c93fe0 commit 4dc433a

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ We welcome community contributions! To add a new token to the list:
8282

8383
After merging changes to `main`:
8484

85-
1. Create a GitHub Release with a tag matching the version in `tokens/token-list.json` (e.g., `v1.2.0`)
86-
- The tag must use the format `v<MAJOR>.<MINOR>.<PATCH>` (e.g., `v1.2.0`)
85+
1. Create a GitHub Release with a tag matching the version in `tokens/token-list.json` (e.g., `1.2.0`)
86+
- The tag must use the format `<MAJOR>.<MINOR>.<PATCH>` (e.g., `1.2.0`) — no `v` prefix
8787
- Ensure the release tag matches the version in your token list exactly
8888
2. The deployment workflow will automatically:
8989
- Update the timestamp to the current deployment time
@@ -93,6 +93,8 @@ After merging changes to `main`:
9393

9494
Monitor deployment progress in the [Actions tab](https://github.com/RequestNetwork/request-token-list/actions/workflows/deploy.yml) of this repository.
9595

96+
**Note**: Git tags do not use a `v` prefix (e.g., `1.2.0`), but the deployed files on GitHub Pages do (e.g., `v1.2.0.json`). The `v` prefix is added by the deployment workflow automatically.
97+
9698
**Note**: The workflow does not validate that the release tag matches the version in `tokens/token-list.json`. If they don't match, the deployed version will use the version from the JSON file, not the release tag. Always ensure they match to avoid confusion.
9799

98100
## Development

0 commit comments

Comments
 (0)