workflows(release): record current release on kipher-core

Author: jhdcruz

.github/workflows/docs.yml

@@ -39,7 +39,7 @@ jobs:
 
       - name: Replace version on project gradle.properties
         run: |
-          cd ${{ steps.module.outputs.module_name }}
+          cd ${{ inputs.project }}
           sed -i "/^VERSION=/ s/=.*/=${{ inputs.version }}/" gradle.properties
 
       - name: remove SNAPSHOT on root gradle.properties

.github/workflows/release-record.yml

@@ -0,0 +1,70 @@
+name: record
+
+on:
+  workflow_call:
+    inputs:
+      project:
+        description: "Project to update."
+        type: string
+        required: true
+      version:
+        description: "Version to rewrite in gradle.properties."
+        type: string
+        required: true
+
+env:
+  GRADLE_OPTS: -Dorg.gradle.jvmargs="-XX:MaxMetaspaceSize=2g"
+  JDK_VERSION: 19
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    outputs:
+      check: ${{ steps.check.outputs.record }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Check if module needs to be recorded
+        id: check
+        run: |
+          # check if CURRENT_RELEASE is present in gradle.properties
+          cd ${{ inputs.project }}
+
+          if grep -q "^CURRENT_RELEASE=" gradle.properties; then
+            echo "CURRENT_RELEASE is present"
+            echo "record=true" >> $GITHUB_OUTPUT
+          else
+            echo "CURRENT_RELEASE is not present"
+            echo "record=false" >> $GITHUB_OUTPUT
+          fi
+
+  record:
+    needs: check
+    if: needs.check.outputs.check == 'true'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Update previous release version
+        run: |
+          cd ${{ inputs.project }}
+          sed -i "/^CURRENT_RELEASE=/ s/=.*/=${{ inputs.version }}/" gradle.properties
+
+      - name: Commit latest docs
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git commit -am "chore(gradle): record current release version [skip-ci]"
+
+      - name: Push to repository
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -47,12 +47,15 @@ jobs:
       - name: remove SNAPSHOT on root gradle.properties
         run: sed -i '/^VERSION=/ s/-SNAPSHOT//' gradle.properties
 
-      # this avoids relying on snapshot dependency on kipher-core
+      # this avoids relying on early-version snapshot dependency on kipher-core
       - name: remove SNAPSHOT suffix on kipher-core version
         if: ${{ steps.module.outputs.module_name }} != "kipher-core"
         run: |
           cd kipher-core
-          sed -i '/^VERSION=/ s/-SNAPSHOT//' gradle.properties
+          # remove VERSION from gradle.properties
+          sed -i '/VERSION/d' gradle.properties
+          # use CURRENT_RELEASE as VERSION
+          sed -i "s/CURRENT_RELEASE/VERSION/" gradle.properties
 
       - name: replace version on project gradle.properties
         run: |
@@ -82,7 +85,7 @@ jobs:
         uses: mindsers/changelog-reader-action@v2
         with:
           validation_level: warn
-          version: ${{ steps.version_name.outputs.version }}
+          version: ${{ steps.tag.outputs.version }}
           path: docs/CHANGELOG-${{ steps.module.outputs.module_name }}.md
 
       - name: Create release
@@ -99,6 +102,14 @@ jobs:
           artifacts: |
             ${{ steps.module.outputs.module_name }}/build/libs/*
 
+  record:
+    needs: publish
+    uses: ./.github/workflows/release-record.yml
+    with:
+      project: ${{ needs.publish.outputs.module_name }}
+      version: ${{ needs.publish.outputs.version }}
+    secrets: inherit
+
   docs:
     needs: publish
     uses: ./.github/workflows/docs.yml

kipher-core/gradle.properties

@@ -1,6 +1,10 @@
 ARTIFACT_ID=kipher-core
 VERSION=0.2.0-SNAPSHOT
 
+# This is used for the release process,
+# to avoid relying on early versions declared in VERSION.
+CURRENT_RELEASE=0.1.0
+
 POM_NAME=kipher-core
 POM_DESCRIPTION=Common utility libraries used by other kipher modules.