Skip to content

Commit 1aae470

Browse files
committed
Some minor release docs improvements
1 parent cbe393e commit 1aae470

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

docs/release.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,28 @@
33
We use [trusted publishing with PyPI](https://docs.astral.sh/uv/guides/integration/github/#publishing-to-pypi) for our release.
44
Check the `.github/workflows/release.yaml` workflow.
55

6-
Currently in order to release:
6+
## Steps to release
77

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`
8+
1. Edit the version on `pyproject.toml`
9+
2. Run `uv lock` to update `uv.lock` file
10+
3. Commit changes: `git add pyproject.toml uv.lock && git commit -m "Bump version to 0.X.Y"`
11+
4. Create release tag: `git tag -a v0.X.Y -m "Release v0.X.Y"`
12+
5. Push tag: `git push origin v0.X.Y`
1113

12-
Check the github action for the tag was successful, validate the wheel and source distribution is on PyPI
14+
Check the github action for the tag was successful, validate the wheel and source distribution is on PyPI.
15+
16+
## Testing locally before release (optional)
17+
18+
```bash
19+
# Clean old builds
20+
rm -rf dist/
21+
22+
# Build
23+
uv build
24+
25+
# Smoke test wheel
26+
uv run --isolated --no-project --with dist/*.whl datanomy --help
27+
28+
# Smoke test source distribution
29+
uv run --isolated --no-project --with dist/*.tar.gz datanomy --help
30+
```

0 commit comments

Comments
 (0)