Skip to content

RELEASING.md

Latest commit

 

History

History
45 lines (37 loc) · 1.78 KB

RELEASING.md

File metadata and controls

45 lines (37 loc) · 1.78 KB

Production Releases

  1. Checkout origin/main.
  2. Update the CHANGELOG.md file with the changes of this release (the format is based on Keep a Changelog.
    • Copy the template for the next unreleased version at the top.
    • Delete unused section in the new release.
    • Update the links at the bottom of the CHANGELOG.md file and don't forget to change the link for the unreleased version.
  3. Update the version in gradle.properties and remove the -SNAPSHOT suffix.
  4. Commit the changes and create a tag: 
    git commit -am "Releasing v0.1.0."
git tag v1.0.0
  5. Update the version in gradle.properties and add the -SNAPSHOT suffix.
  6. Commit the change: 
    git commit -am "Prepare next development version."
  7. Push the two commits. This will start a Github action that publishes the release to Maven Central and creates a new release on Github. 
    git push && git push --tags
  8. Close and release the staging repository at Sonatype.

Snapshot Releases

Snapshot releases are automatically created whenever a commit to the main branch is pushed.

For other branches, maintainers can manually trigger a snapshot release from the publish-snapshot workflow. The version of that snapshot corresponds to the branch name. For example, a branch named feature/branch will have a snapshot version of feature-branch-SNAPSHOT.

Manually uploading a release

Depending on the version in the gradle.properties file it will be either a production or snapshot release.

./gradlew clean publish --no-daemon --no-parallel --no-build-cache

Installing in Maven Local

./gradlew publishToMavenLocal