Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
8 changes: 7 additions & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Loading