How to release

This is documenting the release & deployment process.

We’re using semantic versioning where major.minor.patch should be set accordingly.

VERSION=major.minor.patch

Update pyproject.toml and tag

Update the pyproject.toml version to match the new release version.

sed --regexp-extended 's/^version = "(.+)"/version = "'$VERSION'"/' --in-place pyproject.toml

Then commit and tag:

git commit -a -m ":bookmark: $VERSION"
git tag -a $VERSION -m ":bookmark: $VERSION"

Push everything including tags:

git push
git push --tags

This process is handled automatically by GitHub Actions. If needed below are the instructions to perform it manually. Build it:

make release/build

Check archive content:

tar -tvf dist/edilkamin-*.tar.gz

Upload:

make release/upload

You may want to add some GitHub release notes, by attaching a release to the newly pushed tag.