Document release steps

thoughtworks · Sep 15, 2022 · 397f166 · 397f166
1 parent 756bd8d
commit 397f166
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -101,3 +101,13 @@ Due to the config-driven nature of the tool, there are a number of tests which l
 
 Currently, core maintainer privileges are only available to Thoughtworkers. A setup guide is available [here (internal only)](https://docs.google.com/document/d/1r56rDyGOnRQAAMyHtUHflML1szdvQJMi8p3bzMNB_8A/edit#).
 
+## Releasing
+
+Needs to be more automated. Current we are experimenting with using [Reckon](https://github.com/ajoberstar/reckon) to determine versions from flags.
+
+Current release process looks like
+1. Tag locally and push
+    ```shell
+    ./gradlew -Preckon.stage=final reckonTagPush
+    ```
+2. This will trigger a build on GitHub Actions and push to GHCR. Create a new elease on Github via https://github.com/ThoughtWorks-SEA/recce/releases
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -288,3 +288,7 @@ tasks.jibDockerBuild.configure {
         }
     }
 }
+
+tasks.reckonTagCreate {
+    dependsOn(tasks.check)
+}