mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-08 12:36:54 +03:00
18 lines
1.4 KiB
Markdown
18 lines
1.4 KiB
Markdown
# Release Procedure
|
|
Follow these steps to create a release:
|
|
1. Document all relevant changes in the [Changelog](https://github.com/jomjol/AI-on-the-edge-device/blob/rolling/Changelog.md) in the `main` branch.
|
|
To get a list of commits, you can call `git log --oneline` or check [commits/main/](https://github.com/jomjol/AI-on-the-edge-device-docs/commits/main/). Summarize the relevant changes since the last release.
|
|
1. Wait for the GitHub action to run successfully.
|
|
1. Test it to see if everything worsk as expected.
|
|
1. Go to [releases/new](https://github.com/jomjol/AI-on-the-edge-device/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.
|
|
1. 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
|
|
7. In case of a full release (not a pre-release), check that the [Web Installer](https://jomjol.github.io/AI-on-the-edge-device) shows the right version. If needed, run he action manually: [github.com/jomjol/AI-on-the-edge-device/actions/workflows/manual-update-webinstaller.yml](https://github.com/jomjol/AI-on-the-edge-device/actions/workflows/manual-update-webinstaller.yml).
|