RELEASE.md

Release Procedure

Manual Release

publish script

The manual release could be made with the scripts/publish.ps1. It supports 3 argumenbts:

1. Version: the version try to release
2. CommitMessage: the commit message we will use to tag the release
3. DryRun: dry run without make any changes

Example:

.\scripts\publish.ps1 -Version test -DryRun 1

It does the followings:

1. Bump-up version from VERSION
2. Setup the virtual env for release
3. Run unit-test
4. Build the release
5. Publish to pypi (may ask username/password)
6. Tag a version

Push tags

After the execution, it tags a version to the local repo. We need to push to remote:

git push --tags

Create release

We can go to release page to make a new release with the pushed tag. We could use Generate release notes button to generate from the predefined release notes.

Please don't forget to check Create a discussion for this release checkbox

GitHub Actions Release

Bump-up version

We could trigger the GitHub action to create a PR for Bump-up version.

Publish release

We could trigger the GitHub action to publish a release.

It uses the PyPI API token, a private repo secret, to push the release.

Push tags

TODO: we could create a GitHub action to build the tag and push it.

We need to create the tag by ourselves manually and push to the repo:

git tag -a $(cat ./VERSION)
git push --tags

Create release

TODO: we could create a GitHub action to create the release with the pushed tag.

We can go to release page to make a new release with the pushed tag. We could use Generate release notes button to generate from the predefined release notes.

Please don't forget to check Create a discussion for this release checkbox