Publishing a new version

The UMH uses the semantic versioning. This article explains how to increase the version number and what steps are needed to take

1. Create release branch (e.g., 0.6.0) from main. Docker will automatically build Docker containers with the tag VERSION-prerelease, e.g., 0.6.0-prerelease

2. Create PR from release branch to main

3. Update the helm charts united-manufacturing-hub by going into Charts.yaml and changing the version to the next version including a prerelease

4. Adjust repo link https://repo.umh.app in docs/static/examples/development.yaml to the deploy-preview of helm-repo, e.g., https://deploy-preview-515--umh-helm-repo.netlify.app/ with 515 being the PR created in Step 2. Additionally, add a -devel flag the helm install commands, so that helm considers the prerelease as a valid version.

5. Go into the folder deployment/helm-repo and execute

   helm package ../united-manufacturing-hub/
   
   

6. Go into deployment/helm-repo and execute helm repo index --url https://deploy-preview-515--umh-helm-repo.netlify.app/ --merge index.yaml .

7. Commit changes. Wait for all container and deploy previews to be created. Conduct test on K300 by specifying the new cloud-init file e.g., https://deploy-preview-515--umh-rep.netlify.app/cloud-init/development.yaml (you can create a bit.ly link for that)

8. Test

9. Conduct steps 3 - 6 with changed version 0.6.0 (instead of 0.6.0-prerelease) and changed repo index url: https://repo.umh.app

10. Remove old helm packages from prerelease from repo

11. Merge PR from staging to main

12. Add a new release containing a changelog of all changes

    1. Use the github feature to generate the changelogs and create a new section at the top, for release highlights