diff --git a/README.md b/README.md index c807f2a..0e09ffd 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This library assists developers with graphics programming. ## Installation `graphik` has not been published to PyPI yet (see [RELEASING.md](RELEASING.md) for the release process), so `pip install graphik` will not resolve until the -first release is tagged. Until then, install directly from this repository: +first release is published. Until then, install directly from this repository: ```bash pip install git+https://github.com/Stephenson-Software/graphik.git ``` diff --git a/RELEASING.md b/RELEASING.md index 3c0398e..96a37c0 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -47,7 +47,13 @@ this repository: - publishes to PyPI via Trusted Publishing. The tag must equal `v` + `__version__` (e.g. `__version__ = "0.2.0"` → tag -`v0.2.0`), or the build fails fast before anything is published. +`v0.2.0`). A `v`-prefixed tag whose version does not match `__version__` fails +the build before anything is published. A tag **without** the `v` prefix fails +silently instead: it matches no trigger in `publish.yml`, so the workflow never +runs and nothing reports the missed release. The `0.2.0` and +`0.3.0.dev20260808` tags were pushed that way, so the publish workflow has never +run (tracked in +[#34](https://github.com/Stephenson-Software/graphik/issues/34)). ## Installing (after the first publish)