@@ -12,8 +12,8 @@ clastic uses CalVer: `YY.MINOR.MICRO` (e.g. `26.0.1`). The version lives in
1212` clastic/__init__.py ` as a ` __version__ ` literal string. During development it
1313carries a ` dev ` suffix (e.g. ` 26.0.1dev ` ). Flit reads this at build time.
1414
15- Tags use the ` v ` prefix (e.g. ` v26 .0.1` , NOT ` 26 .0.1` ). The publish workflow
16- triggers on tags matching ` v [0-9]*.[0-9]*.[0-9]*` .
15+ Tags do NOT use a ` v ` prefix (e.g. ` 26 .0.1` , NOT ` v26 .0.1` ). The publish workflow
16+ triggers on tags matching ` [0-9]*.[0-9]*.[0-9]* ` .
1717
1818## Pre-flight checks
1919
@@ -88,10 +88,10 @@ Use the exact format `clastic version X.Y.Z` for the commit message.
8888### 5. Tag the release
8989
9090``` bash
91- git tag -a v26 .0.1 -m " short summary of key changes in this release"
91+ git tag -a 26 .0.1 -m " short summary of key changes in this release"
9292```
9393
94- Tags use the ` v ` prefix. The tag message should be a short,
94+ Tags do NOT use a prefix. The tag message should be a short,
9595lowercase, descriptive summary of the release (not just the version number).
9696Examples:
9797
@@ -124,7 +124,7 @@ This triggers two GitHub Actions workflows:
124124- ` Publish to PyPI ` (on the tag)
125125
126126The publish workflow validates that ` __version__ ` on the tagged commit does
127- not contain ` dev ` and matches the tag (after stripping the ` v ` prefix) . It
127+ not contain ` dev ` and matches the tag. It
128128parses ` __version__ ` from the file with ` sed ` rather than importing the module
129129(the build job does not install dependencies). If either check fails,
130130publishing is blocked.
@@ -155,14 +155,14 @@ Report the results to the user.
155155- ** Failed release** (tag exists locally/on GitHub but not on PyPI): PyPI is
156156 the source of truth. Delete the stale tag locally and on the remote:
157157 ```bash
158- git tag -d vX .Y.Z
159- git push origin :refs/tags/vX .Y.Z # if it was pushed
158+ git tag -d X .Y.Z
159+ git push origin :refs/tags/X .Y.Z # if it was pushed
160160 ```
161161 Then check `__version__` in `clastic/__init__.py`. If it was already bumped
162162 past the failed release (e.g. `X.Y.(Z+1)dev`), reset it to `X.Y.Zdev` so
163163 the release flow strips the suffix to the correct version. Amend or revert
164164 the bump commit as needed, then restart the release from step 1.
165- - ** Wrong version tagged** : ` git tag -d vX .Y.Z && git push origin :refs/tags/vX .Y.Z `
165+ - ** Wrong version tagged** : ` git tag -d X .Y.Z && git push origin :refs/tags/X .Y.Z `
166166 then fix and re-tag.
167167- ** Publish workflow failed** : Check the GitHub Actions log. Common causes:
168168 version mismatch, dev suffix present, PyPI trusted publisher not configured.
0 commit comments