Release Steps

This document describes the steps for releasing new versions of this project.

Step 1 - Create the new release

1. Make sure that all changes have been committed and the repository is clean.
2. Change the version tag numbers using the command:

./set_version <version>-SNAPSHOT <version>

3. Update CHANGELOG.md file with the release date.
4. Commit changes with commit message "Released version <version>":

git commit -m "Released version <version>"

5. Create a new git tag named <version>. The git tag should include only the version number without the v prefix.
6. Make sure to push the changes to the Git repository (including the new tag).
7. Create the release on the GitHub releases page. Make sure to associate the release with the tag created for the new version.

Step 2 - Prepare for the next development cycle

1. Change version numbers to the next version number:

./set_version <version> <next-version>-SNAPSHOT

2. Update CHANGELOG.md file creating space for the next version's changes
3. Commit changes files with the message: "Preparing for the next development cycle: <next-version>-SNAPSHOT"

git commit -m "Preparing for the next development cycle: <next-version>-SNAPSHOT"

4. Push the changes to the Git repository