diff --git a/Release-Procedure.md b/Release-Procedure.md index e33424b..1b1d0b2 100644 --- a/Release-Procedure.md +++ b/Release-Procedure.md @@ -1,3 +1,5 @@ +The release procedure is now _easy_ and uses Gradle tasks for each step. This ensures each release process is consistent from release to release and removes as much of the user error as possible. + 1. Change project `version` by removing SNAPSHOT * Edit `build.gradle.kts` and **commit locally** with relevant version message 1. Generate clean tested release build @@ -7,7 +9,7 @@ 1. Verify artifacts & release to Maven Central 1. Generate GitHub release **draft** * `./gradlew -Prelease=true githubRelease` - * NOTE: This downloads the artifacts from Maven Central to ensure exact artifacts are used. Ensure the release process is finished before execution (usually only takes a couple minutes). + * NOTE: This downloads the artifacts from Maven Central to ensure exact artifacts are used. Ensure the Maven release process is finished before executing the Gradle task (usually only takes a couple minutes). * Verify artifacts in GitHub are correct. 1. Publish documentation to Github Pages * `./gradlew -Prelease=true documentation:gitPublishPush`