Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-08 12:36:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update Release-creation.md

Browse Source
This commit is contained in:
CaCO3
2024-10-06 16:36:53 +02:00
committed by GitHub
parent e1425cb29e
commit 6a8aa60afc
1 changed files with 14 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/Release-creation.md
View File

@@ -1,25 +1,17 @@
# Preparing for Release
1. [Changelog](https://github.com/jomjol/AI-on-the-edge-device/blob/rolling/Changelog.md) is merged back from `master` branch to `rolling` branch (should be the last step of the previous release creation)
1. All changes are documented in the [Changelog](https://github.com/jomjol/AI-on-the-edge-device/blob/rolling/Changelog.md) in `rolling` branch.
To get a list of commits, call `git log --oneline`. Summarize the relevant changes since the last release.
## Release creation steps
1. Merge`rolling` into `master` branch
2. Best to wait for the GitHub action to run successfully
3. On `master` branch tag the version like `v11.3.1` and don't forget to push it:
```
git checkout master
git pull
git tag v14.0.0
git push --tags
```
5. Wait for the GitHub-Action of release creation. After all is done:
# 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
6. Merge master back in `rolling`
7. 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).
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).