RELEASING.md

Releasing

X.Y.Z used as a stand-in for the new version.

1. Checkout main: git checkout main
2. Ensure the local copy is up to date: git pull --ff-only
3. Create a new branch git checkout -b bump_to_X.Y.Z
4. Change the version in build.gradle.kts to the desired version.
5. Update the CHANGELOG.md for the impending release, including the date (YYYY-MM-DD).
6. Update the README.md with the new version.
7. Stage the edited files: git add build.gradle.kts CHANGELOG.md README.md
8. Commit the edited files: git commit -m "Bump version to X.Y.Z."
9. Push the changes: git push --set-upstream origin bump_to_X.Y.Z
10. Create a new pull request & get it merged
11. Create a new Github release:
    • tag name: vX.Y.Z
    • release name: vX.Y.Z Release
12. Verify the pipeline published the package to Bintray successfully.