Skip to content

Update release docs #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jacobo-doist merged 2 commits into from
Sep 12, 2025
Merged

Update release docs #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
584abfb
chore: Upgrade uv lock
jacobo-doist Sep 12, 2025
5eb6ff6
chore: Update release instructions to use uv
jacobo-doist Sep 12, 2025
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
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,12 +360,21 @@ uv run pytest

## Releasing new versions

- Bump version in `pyproject.toml` (or use `uv version`)
- Update the CHANGELOG
- Commit the changes with a commit message "Version X.X.X"
- Tag the current commit with `vX.X.X`
- Create a new release on GitHub named `vX.X.X`
- GitHub Actions will publish the new version to PyPI for you
1. Bump version in `pyproject.toml` (or use `uv version`)
```sh
uv version --bump minor
```
1. Update the CHANGELOG
1. Commit the changes with a commit message "Version X.X.X"
```sh
git commit -m "Version $(uv version --short)"
```
1. Tag the current commit with `vX.X.X`
```sh
git tag -a -m "Release $(uv version --short)" "v$(uv version --short)"
```
1. Create a new release on GitHub named `vX.X.X`
1. GitHub Actions will publish the new version to PyPI for you

## Legal

Expand Down
Loading