Add semi-automated tagging and generating GH Release draft to CICD (#37)

Author: jakipatryk

.github/workflows/release_draft.yml

@@ -0,0 +1,92 @@
+#
+# Copyright 2023 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: Release - create draft release
+on:
+  workflow_dispatch:
+    inputs:
+      tagName:
+        description: 'Name of git tag to be created, and then draft release created. Syntax: "v[0-9]+.[0-9]+.[0-9]+".'
+        required: true
+
+jobs:
+  tag:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Validate format of received tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const newTag = core.getInput('tag-name');
+            const regex = /^v[0-9]+\.[0-9]+\.[0-9]+$/;
+            
+            if (!regex.test(newTag)) {
+              core.setFailed('Tag does not match the required format "v[0-9]+.[0-9]+.[0-9]+"');
+              return;
+            }
+          tag-name: ${{ github.event.inputs.tagName }}
+      - name: Create and push tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const tag = core.getInput('tag-name')
+            const ref = `refs/tags/${tag}`;
+            const sha = context.sha; // The SHA of the commit to tag
+        
+            await github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: ref,
+              sha: sha
+            });
+        
+            console.log(`Tag created: ${tag}`);
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          tag-name: ${{ github.event.inputs.tagName }}
+
+  release:
+    needs: tag
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: refs/tags/${{ github.event.inputs.tagName }}
+      - name: Generate release notes
+        id: generate_release_notes
+        uses: AbsaOSS/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          chapters: |
+            [
+              {"title": "Breaking Changes 💥", "label": "breaking-change"},
+              {"title": "New Features 🎉", "label": "enhancement"},
+              {"title": "Bugfixes 🛠", "label": "bug"}
+            ]
+          warnings: true
+      - name: Create draft release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: ${{ github.event.inputs.tagName }}
+          body: ${{ steps.generate_release_notes.outputs.releaseNotes }}
+          draft: true
+          prerelease: false

.github/workflows/release.yml renamed to .github/workflows/release_publish.yml

@@ -14,9 +14,10 @@
 # limitations under the License.
 #
 
-name: Release
+name: Release - publish artifacts
 on:
-  workflow_dispatch:
+  release:
+    types: [released]
 
 jobs:
   publish:
@@ -27,8 +28,9 @@ jobs:
           fetch-depth: 0
       - uses: olafurpg/setup-scala@v14
         with:
-          java-version: "[email protected]"
-      - run: sbt ci-release
+          java-version: "[email protected]"
+      - name: Build and release to Sonatype and Maven Central
+        run: sbt ci-release
         env:
           PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
           PGP_SECRET: ${{ secrets.PGP_SECRET }}