1. Release Procedure
Follow these steps to create a release:
- Document all relevant changes in the Changelog in the
main
branch. To get a list of commits, you can callgit log --oneline
or check commits/main/. Summarize the relevant changes since the last release. - Wait for the GitHub action to run successfully.
- Test it to see if everything worsk as expected.
- Update the contributors list in the README.md by triggering the Manually update contributors list action.
-
Go to releases/new to create a new release. Fill in a new tag and select "Create new tag: xxx on publish".
A tag should have the format x.y.z.
It is suggested to first select "Set as a pre-release" at the bottom. -
Wait for the GitHub-Action of release creation. After all is done:
- the release should be created
- the artifacts are downloadable from release
- The documented changes were applied to the release
- In case of a full release (not a pre-release), check that the Web Installer shows the right version. If needed, run he action manually: github.com/jomjol/AI-on-the-edge-device/actions/workflows/manual-update-webinstaller.yml.