RELEASING.md

Releasing

1. Update the VERSION_NAME in gradle.properties to the release version (i.e., no "-SNAPSHOT" suffix).

2. Update the CHANGELOG.md:

   1. Change the Unreleased header to the release version.
   2. Add a link URL to the bottom of the page, to ensure the header link works.
   3. Add a new Unreleased section to the top.

3. Update the README.md so the "Download" section reflects the new release version and the snapshot section reflects the next "SNAPSHOT" version.

4. Commit

   $ git commit -am "Prepare version X.Y.Z"
   

5. Tag

   $ git tag -am "Version X.Y.Z" X.Y.Z
   

6. Update the VERSION_NAME in gradle.properties to what is likely the next version and re-append the "-SNAPSHOT" suffix'

7. Commit

   $ git commit -am "Prepare next development version"
   

8. Push!

   $ git push && git push --tags
   

   This will trigger a GitHub Action workflow which will create a GitHub release, upload the release artifacts to Sonatype Nexus, and trigger synchronization to Maven Central.

   You're done!