Creating a New Release

To create a new release, follow these steps:

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

2. Create a new branch for your release. The branch name should follow the format: 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 file from all news fragments:

   Build a combined changelog from news fragment

   $ towncrier build [--yes]
   

6. Commit your changes with a message that describes the release.

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.

9. Tag the commit in the main branch with the version number. The release process is triggered by this tag in the format MAJOR.MINOR.PATCH.

   For example, if you are releasing version 1.1.0, you would tag the commit as follows:

   Tag the release commit

    $ git tag 1.1.0
    $ git push origin 1.1.0
   

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