Making a new release

  • Make sure to populate CHANGELOG.md and change the version number (see this commit for example).

  • Commit and push the changes above to Github, merge the PR (if releasing from main; there should be no PR for releases from other branches).

  • Make sure a CI run is triggered, either automatically or manually, and wait for the run to finish.

  • The previous step will have created an agent Docker image, which you can use for final testing before the release. Once everything looks good, tag the commit (e.g. git tag v0.1.8) and push it to Github (e.g. git push origin tag v0.1.8).

  • Make a release on Github based on the pushed tag. Copy the relevant CHANGELOG.md part to the release notes; see this page for example.