diff --git a/docs/_dev/publish.md b/docs/_dev/publish.md new file mode 100644 index 0000000..ef23dd5 --- /dev/null +++ b/docs/_dev/publish.md @@ -0,0 +1,9 @@ +# Publish & Release process + +1. Add the respective note in the [CHANGELOG](../../CHANGELOG.md) +1. Bump `project.version` in the [package manifest](../../pyproject.toml) +1. Create a release on GitHub + * Release tag SHOULD be prefixed with `v` + * Release tag MUST match the new version + +The GitHub release will trigger the [publihs workflow](../../.github/workflows/python-publish.yml)