Skip to content

Commit a674afa

Browse files
committed
add release docs
1 parent da96abc commit a674afa

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ deployments yet.
2222
- [Approach](#approach)
2323
- [Plugin Development](#plugin-development)
2424
- [Automated Tests](#automated-tests)
25+
- [Releasing](#releasing)
2526

2627
## Motivation
2728

@@ -273,3 +274,28 @@ uv run pytest
273274
# To skip platform_agnostic_tests for faster feedback during plugin development:
274275
uv run pytest --ignore=tests/integration_tests/platform_agnostic_tests
275276
```
277+
278+
### Releasing
279+
280+
1. Bump the version in `pyproject.toml`:
281+
```sh
282+
uv version --bump patch # or --bump minor/major
283+
```
284+
285+
2. Add release notes to `CHANGELOG.md`
286+
287+
3. Create a new release on GitHub:
288+
- Tag the version (e.g., `v0.2.1`)
289+
- Add the same release notes
290+
- Publish the release
291+
292+
When the release is published, CI automatically builds and publishes the package to PyPI.
293+
294+
<!-- omit in toc -->
295+
#### Test Release
296+
297+
If you're testing a release, you can use `test.pypi.org` with a command like:
298+
299+
```sh
300+
op run --env-file ../.testpypi -- uv publish --publish-url https://test.pypi.org/legacy/
301+
```

0 commit comments

Comments
 (0)