Skip to content

Commit 24a6a89

Browse files
authored
Update release docs (#79)
* chore: Upgrade uv lock * chore: Update release instructions to use uv
1 parent 04494e6 commit 24a6a89

File tree

2 files changed

+190
-181
lines changed

2 files changed

+190
-181
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -360,12 +360,21 @@ uv run pytest
360360

361361
## Releasing new versions
362362

363-
- Bump version in `pyproject.toml` (or use `uv version`)
364-
- Update the CHANGELOG
365-
- Commit the changes with a commit message "Version X.X.X"
366-
- Tag the current commit with `vX.X.X`
367-
- Create a new release on GitHub named `vX.X.X`
368-
- GitHub Actions will publish the new version to PyPI for you
363+
1. Bump version in `pyproject.toml` (or use `uv version`)
364+
```sh
365+
uv version --bump minor
366+
```
367+
1. Update the CHANGELOG
368+
1. Commit the changes with a commit message "Version X.X.X"
369+
```sh
370+
git commit -m "Version $(uv version --short)"
371+
```
372+
1. Tag the current commit with `vX.X.X`
373+
```sh
374+
git tag -a -m "Release $(uv version --short)" "v$(uv version --short)"
375+
```
376+
1. Create a new release on GitHub named `vX.X.X`
377+
1. GitHub Actions will publish the new version to PyPI for you
369378

370379
## Legal
371380

0 commit comments

Comments
 (0)