diff --git a/Release-Procedure.md b/Release-Procedure.md new file mode 100644 index 0000000..e33424b --- /dev/null +++ b/Release-Procedure.md @@ -0,0 +1,21 @@ +1. Change project `version` by removing SNAPSHOT + * Edit `build.gradle.kts` and **commit locally** with relevant version message +1. Generate clean tested release build + * `./gradlew -Prelease=true clean build` +1. Publish signed artifacts to Maven Central Staging + * `./gradlew -Prelease=true publish` +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). + * Verify artifacts in GitHub are correct. +1. Publish documentation to Github Pages + * `./gradlew -Prelease=true documentation:gitPublishPush` +1. Increment project `version` to **next** SNAPSHOT + * Edit `build.gradle.kts` and **commit locally** with relevant version message +1. Push versioning commits to origin + * `git push` +1. Finalize GitHub release + * From "recent commits" ensure the release commit is selected + +๐ŸŽ‰Done๐ŸŽ‰ \ No newline at end of file