Creating a New Release#

When you are ready to release a new version of the project, start with creating a new release branch. There you bump the version, build the changelog, and adjust minor things like the documentation. Avoid commiting changes that introduces new features or add breaking changes.

Follow these steps:

  1. Ensure that you have the latest changes from the main branch of the repository.

  2. Create a new branch named release/<VERSION>, where <VERSION> is the version number you are releasing (e.g., release/1.0.0).

  3. Bump the version.

  4. Update the project.

  5. Build the changelog.

  6. In your current branch, push the branch to the remote repository:

    git push origin HEAD

  7. Wait for the CI to pass. If it fails, fix the issues and commit again.

  8. If the CI passes, (squash-)merge your release branch into the main branch. The GitHub Action workflow will automatically create a new release based on the name of the release branch.

  9. Find the release in the GitHub repository under the Releases section.