Skip to content

Commit 362a631

Browse files
docs: document release process in README
1 parent c8c0009 commit 362a631

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,7 @@ isort oc4ids_datastore_api/ tests/
4040
flake8 oc4ids_datastore_api/ tests/
4141
mypy oc4ids_datastore_api/ tests/
4242
```
43+
44+
## Releasing
45+
46+
To publish a new version, raise a PR to `main` updating the version in `pyproject.toml`. Once merged, create a git tag and GitHub release for the new version, with naming `vX.Y.Z`. This will trigger a docker image to to be built and pushed, tagged with the version and `latest`.

0 commit comments

Comments
 (0)