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-06 03:26:54 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
AI-on-the-edge-device-docs/docs/Release-creation.md
Adriaan Van Niekerk 0cd98c67e2 Add Makefile and Markdown linter (#73) 
* Add Makefile

* Update .gitignore to exclude venv

* Add requirements.txt for venv

* Add pymarkdown lint Github action

* Update .md from lint tool

* Update README with make commands

* Add linter config
2025-10-31 00:06:36 +01:00

1.6 KiB
Raw Permalink Blame History

Release Procedure

Follow these steps to create a release:

  1. Document all relevant changes in the Changelog in the main branch. To get a list of commits, you can call git log --oneline or check commits/main/. Summarize the relevant changes since the last release.

  2. Wait for the GitHub action to run successfully.

  3. Test it to see if everything worsk as expected.

  4. Update the contributors list in the README.md by triggering the Manually update contributors list action.

  5. 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.

  6. 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 shows the right version. If needed, run he action manually: github.com/jomjol/AI-on-the-edge-device/actions/workflows/manual-update-webinstaller.yml.