Skip to content

Commit 5cc22e1

Browse files
committed
Add some notes on how to release
1 parent 36948f9 commit 5cc22e1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/release.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Release procedure
2+
3+
We use [trusted publishing with PyPI](https://docs.astral.sh/uv/guides/integration/github/#publishing-to-pypi) for our release.
4+
Check the `.github/workflows/release.yaml` workflow.
5+
6+
Currently in order to release:
7+
8+
- Edit the version on `pyproject.toml`
9+
- Run `uv lock` to update `uv.lock` file
10+
- Create release tag and push `git tag -a v0.2.0 -m v0.2.0`, `git push origin v0.2.0`
11+
12+
Check the github action for the tag was successful, validate the wheel and source distribution is on PyPI

0 commit comments

Comments
 (0)