Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MantisClone merged 2 commits into from
Mar 13, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc2ab8f
fix: correct tag format in README publish procedure
MantisClone Mar 13, 2026
10080db
fix: note that deployed files use v prefix but git tags do not
MantisClone Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ We welcome community contributions! To add a new token to the list:

After merging changes to `main`:

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

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

**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.

**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.

## Development
Expand Down
Loading