Make a Release¶

We did implement different CI/CD pipelines with GitHub Actions. This eases the release process but a small checklist is always a great help.

  1. Update the version

    # make sure you are on the right branch
    git checkout develop
    
    # update the version.txt to the targeted version
    git add version.txt
    git commit -m "update version.txt"
    git push origin develop
    
  2. Add a tag to the commit

    git tag vx.y
    git push origin vx.y
    
  3. Release

    git checkout master
    git merge develop
    
  4. Check if everything went well