Prepare the official release workflow

scala · Jun 8, 2024 · 2a46134 · 2a46134
1 parent 857bf12
commit 2a46134
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 5 deletions.
diff --git a/.github/workflows/release-sdkman.yml → .github/workflows/publish-sdkman.yml b/.github/workflows/release-sdkman.yml → .github/workflows/publish-sdkman.yml
@@ -11,8 +11,8 @@
 ###################################################################################################
 
 
-name: Release Scala to SDKMAN!
-run-name: Release Scala ${{ inputs.version }} to SDKMAN!
+name: Publish Scala to SDKMAN!
+run-name: Publish Scala ${{ inputs.version }} to SDKMAN!
 
 on:
   workflow_call:

diff --git a/.github/workflows/releases.yml b/.github/workflows/releases.yml
@@ -1,12 +1,31 @@
-name: Releases
+###################################################################################################
+###                                  OFFICIAL RELEASE WORKFLOW                                  ###
+### HOW TO USE:                                                                                 ###
+###   - THIS WORKFLOW WILL NEED TO BE TRIGGERED MANUALLY                                        ###
+###                                                                                             ###
+### NOTE:                                                                                       ###
+###   - THIS WORKFLOW SHOULD ONLY BE RUN ON STABLE RELEASES                                     ###
+###   - IT ASSUMES THAT THE PRE-RELEASE WORKFLOW WAS PREVIOUSLY EXECUTED                        ###
+###                                                                                             ###
+###################################################################################################
+
+name: Official release of Scala
+run-name: Official release of Scala ${{ inputs.version }}
+
 on:
   workflow_dispatch:
+    inputs:
+      version:
+        description: 'The version to officially release'
+        required: true
+        type: string
 
 jobs:
+  # TODO: ADD JOB TO SWITCH THE GITHUB RELEASE FROM DRAFT TO LATEST
   publish-sdkman:
-    uses:  ./.github/workflows/release-sdkman.yml
+    uses:  ./.github/workflows/publish-sdkman.yml
     with:
-      version: '???' # TODO: Find a way to extract the version number. Easiest way would be to add it as an input
+      version: ${{ inputs.version }}
     secrets:
       CONSUMER-KEY: ${{ secrets.SDKMAN_KEY }}
       CONSUMER-TOKEN: ${{ secrets.SDKMAN_TOKEN }}