RELEASING.md

Production Releases

1. Checkout origin/main.
2. Update the CHANGELOG.md file with the changes of this release.
3. Update the version in the main gradle.properties.
4. Commit the changes and create a tag:

   git commit -am "Releasing version 1.0.0."
   git tag 1.0.0
   

5. Create the release on GitHub:
   1. Go to the Releases page for the GitHub project.
   2. Click "Draft a new release".
   3. Enter the tag name you just pushed.
   4. Title the release with the same name as the tag.
   5. Copy & paste the changelog entry for this release into the description.
   6. If this is a pre-release version, check the pre-release box.
   7. Hit "Publish release".
   8. Wait for the GitHub Action job to complete; it will attach the artifacts to the release.
6. Close and release the staging repository at Sonatype.
7. Update the version in gradle.properties
8. Commit the change:

   git commit -am "Prepare next development version."
   

9. Push git changes:

   git push && git push --tags
   

Installing in Maven Local

./gradlew clean publishToMavenLocal --no-build-cache

Notes

Snapshot Releases

Builds by default are snapshot releases and the version automatically contains the -SNAPSHOT suffix. You can verify the release here.