ci: Improve Github workflows

- Separate test and build tasks for pull request and push events.
- Improve job and step names to reflect what is actually done in the steps.
- Order env vars alphabetically
- Add BETA env var to doc publishing. This prevents publishing if the release is a milestone or release candidate.
- Centralize user name and email to one place and update Puneets email.
- Remove some redundant env vars that were set to the same as the default values.

Author: matrei

.github/workflows/gradle.yml

@@ -6,6 +6,9 @@ on:
   pull_request:
     branches:
       - '[5-9]+.[0-9]+.x'
+env:
+  GIT_USER_NAME: puneetbehl
+  GIT_USER_EMAIL: behlp@unityfoundation.io
 
 jobs:
 
@@ -26,7 +29,19 @@ jobs:
         with:
           distribution: temurin
           java-version: ${{ matrix.java }}
-      - name: Run Gradle build
+
+      - name: Run Tests
+        if: github.event_name == 'pull_request'
+        uses: gradle/actions/setup-gradle@v3
+        env:
+          GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
+          GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER }}
+          GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY }}
+        with:
+          arguments: check
+
+      - name: Run Build
+        if: github.event_name == 'push'
         uses: gradle/actions/setup-gradle@v3
         env:
           GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
@@ -35,7 +50,7 @@ jobs:
         with:
           arguments: build
 
-  publish_documentation:
+  publish_snapshot:
     name: Publish Snapshot release
     runs-on: ubuntu-latest
     if: github.event_name == 'push'
@@ -46,9 +61,9 @@ jobs:
       - uses: actions/checkout@v4
       - uses: gradle/wrapper-validation-action@v2
       - uses: actions/setup-java@v4
-        with: { distribution: temurin, java-version: 17 }
+        with: { java-version: 17, distribution: temurin }
 
-      - name: Publish to Artifactory (repo.grails.org)
+      - name: Publish Snapshot artifacts to Artifactory (repo.grails.org)
         uses: gradle/actions/setup-gradle@v3
         env:
           GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
@@ -61,7 +76,7 @@ jobs:
             -Dorg.gradle.internal.publish.checksums.insecure=true
             publish
 
-      - name: Generate Documentation
+      - name: Generate Snapshot Documentation
         if: success()
         uses: gradle/actions/setup-gradle@v3
         env:
@@ -71,14 +86,12 @@ jobs:
         with:
           arguments: docs
 
-      - name: Publish to Github Pages
+      - name: Publish Snapshot Documentation to Github Pages
         if: success()
         uses: micronaut-projects/github-pages-deploy-action@grails
         env:
-          TARGET_REPOSITORY: ${{ github.repository }}
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
           BRANCH: gh-pages
+          COMMIT_EMAIL: ${{ env.GIT_USER_EMAIL }}
+          COMMIT_NAME: ${{ env.GIT_USER_NAME }}
           FOLDER: docs/build/docs
-          DOC_FOLDER: gh-pages
-          COMMIT_EMAIL: behlp@unityfoundation.io
-          COMMIT_NAME: Puneet Behl
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/release.yml

@@ -9,33 +9,35 @@ jobs:
 
     env:
       GIT_USER_NAME: puneetbehl
-      GIT_USER_EMAIL: behlp@objectcomputing.com
+      GIT_USER_EMAIL: behlp@unityfoundation.io
 
     steps:
       - uses: actions/checkout@v4
       - uses: gradle/wrapper-validation-action@v2
       - uses: actions/setup-java@v4
         with: { distribution: temurin, java-version: 17 }
 
-      - name: Set the current release version
+      - name: Get the current release version
         id: release_version
-        run: echo "release_version=${GITHUB_REF:11}" >> $GITHUB_OUTPUT
+        run: |
+          echo "Release version: ${GITHUB_REF:11}"
+          echo "release_version=${GITHUB_REF:11}" >> $GITHUB_OUTPUT
 
-      - name: Run pre-release
+      - name: Set projectVersion to the release version
         uses: micronaut-projects/github-actions/pre-release@master
 
-      - name: Generate secring file
+      - name: Generate key file for artifact signing
         env:
           SECRING_FILE: ${{ secrets.SECRING_FILE }}
         run: echo $SECRING_FILE | base64 -d > ${{ github.workspace }}/secring.gpg
 
-      - name: Publish to Sonatype
+      - name: Publish release artifacts to Sonatype
         id: publish_to_sonatype
         uses: gradle/actions/setup-gradle@v3
         env:
           GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
-          GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER }}
           GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY }}
+          GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER }}
           ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USERNAME }}
           ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }}
           ORG_GRADLE_PROJECT_sonatypeStagingProfileId: ${{ secrets.SONATYPE_STAGING_PROFILE_ID }}
@@ -61,18 +63,14 @@ jobs:
         if: success()
         uses: micronaut-projects/github-pages-deploy-action@grails
         env:
-          GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
-          GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_USER }}
-          GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY: ${{ secrets.GRADLE_ENTERPRISE_BUILD_CACHE_NODE_KEY }}
-          TARGET_REPOSITORY: ${{ github.repository }}
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          BETA: ${{ contains(steps.release_version.outputs.release_version, 'M') || contains(steps.release_version.outputs.release_version, 'RC') }}
           BRANCH: gh-pages
+          COMMIT_EMAIL: ${{ env.GIT_USER_EMAIL }}
+          COMMIT_NAME: ${{ env.GIT_USER_NAME }}
           FOLDER: docs/build/docs
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
           VERSION: ${{ steps.release_version.outputs.release_version }}
-          DOC_FOLDER: gh-pages
-          COMMIT_EMAIL: behlp@unityfoundation.io
-          COMMIT_NAME: Puneet Behl
 
-      - name: Run post-release
+      - name: Set projectVersion to the next snapshot version
         if: steps.publish_to_sonatype.outcome == 'success'
         uses: micronaut-projects/github-actions/post-release@master