Harmonize CI structure

Author: snicoll

.github/actions/build/action.yml

@@ -1,31 +1,31 @@
 name: 'Build'
 description: 'Builds the project, optionally publishing it to a local deployment repository'
 inputs:
-  java-version:
+  develocity-access-key:
+    description: 'Access key for authentication with ge.spring.io'
     required: false
-    default: '17'
-    description: 'The Java version to compile and test with'
   java-distribution:
+    description: 'Java distribution to use'
     required: false
     default: 'liberica'
-    description: 'The Java distribution to use for the build'
   java-toolchain:
-    required: false
-    default: 'false'
     description: 'Whether a Java toolchain should be used'
-  publish:
     required: false
     default: 'false'
+  java-version:
+    description: 'Java version to compile and test with'
+    required: false
+    default: '17'
+  publish:
     description: 'Whether to publish artifacts ready for deployment to Artifactory'
-  develocity-access-key:
     required: false
-    description: 'The access key for authentication with ge.spring.io'
+    default: 'false'
 outputs:
   build-scan-url:
-    description: 'The URL, if any, of the build scan produced by the build'
+    description: 'URL, if any, of the build scan produced by the build'
     value: ${{ (inputs.publish == 'true' && steps.publish.outputs.build-scan-url) || steps.build.outputs.build-scan-url }}
   version:
-    description: 'The version that was built'
+    description: 'Version that was built'
     value: ${{ steps.read-version.outputs.version }}
 runs:
   using: composite
@@ -34,9 +34,9 @@ runs:
       uses: ./.github/actions/prepare-gradle-build
       with:
         develocity-access-key: ${{ inputs.develocity-access-key }}
-        java-version: ${{ inputs.java-version }}
         java-distribution: ${{ inputs.java-distribution }}
         java-toolchain: ${{ inputs.java-toolchain }}
+        java-version: ${{ inputs.java-version }}
     - name: Build
       id: build
       if: ${{ inputs.publish == 'false' }}

.github/actions/create-github-release/action.yml

@@ -2,26 +2,26 @@ name: Create GitHub Release
 description: Create the release on GitHub with a changelog
 inputs:
   milestone:
-    description: Name of the GitHub milestone for which a release will be created
-    required: true
-  token:
-    description: Token to use for authentication with GitHub
+    description: 'Name of the GitHub milestone for which a release will be created'
     required: true
   pre-release:
-    description: Whether the release is a pre-release (a milestone or release candidate)
+    description: 'Whether the release is a pre-release (a milestone or release candidate)'
     required: false
     default: 'false'
+  token:
+    description: 'Token to use for authentication with GitHub'
+    required: true
 runs:
   using: composite
   steps:
     - name: Generate Changelog
       uses: spring-io/github-changelog-generator@86958813a62af8fb223b3fd3b5152035504bcb83 #v0.0.12
       with:
+        config-file: .github/actions/create-github-release/changelog-generator.yml
         milestone: ${{ inputs.milestone }}
         token: ${{ inputs.token }}
-        config-file: .github/actions/create-github-release/changelog-generator.yml
     - name: Create GitHub Release
+      shell: bash
       env:
         GITHUB_TOKEN: ${{ inputs.token }}
-      shell: bash
       run: gh release create ${{ format('v{0}', inputs.milestone) }} --notes-file changelog.md ${{ inputs.pre-release == 'true' && '--prerelease' || '' }}

.github/actions/prepare-gradle-build/action.yml

@@ -1,21 +1,21 @@
 name: 'Prepare Gradle Build'
 description: 'Prepares a Gradle build. Sets up Java and Gradle and configures Gradle properties'
 inputs:
-  java-version:
+  develocity-access-key:
+    description: 'Access key for authentication with ge.spring.io'
     required: false
-    default: '17'
-    description: 'The Java version to use for the build'
   java-distribution:
+    description: 'Java distribution to use'
     required: false
     default: 'liberica'
-    description: 'The Java distribution to use for the build'
   java-toolchain:
+    description: 'Whether a Java toolchain should be used'
     required: false
     default: 'false'
-    description: 'Whether a Java toolchain should be used'
-  develocity-access-key:
+  java-version:
+    description: 'Java version to use for the build'
     required: false
-    description: 'The access key for authentication with ge.spring.io'
+    default: '17'
 runs:
   using: composite
   steps:

.github/actions/send-notification/action.yml

@@ -1,33 +1,39 @@
 name: Send Notification
-description: Sends a Google Chat message as a notification of the job's outcome
+description: 'Sends a Google Chat message as a notification of the job''s outcome'
 inputs:
-  webhook-url:
-    description: 'Google Chat Webhook URL'
-    required: true
-  status:
-    description: 'Status of the job'
-    required: true
   build-scan-url:
     description: 'URL of the build scan to include in the notification'
+    required: false
   run-name:
     description: 'Name of the run to include in the notification'
+    required: false
     default: ${{ format('{0} {1}', github.ref_name, github.job) }}
+  status:
+    description: 'Status of the job'
+    required: true
+  webhook-url:
+    description: 'Google Chat Webhook URL'
+    required: true
 runs:
   using: composite
   steps:
-    - shell: bash
+    - name: Prepare Variables
+      shell: bash
       run: |
         echo "BUILD_SCAN=${{ inputs.build-scan-url == '' && ' [build scan unavailable]' || format(' [<{0}|Build Scan>]', inputs.build-scan-url) }}" >> "$GITHUB_ENV"
         echo "RUN_URL=${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" >> "$GITHUB_ENV"
-    - shell: bash
+    - name: Success Notification
       if: ${{ inputs.status == 'success' }}
+      shell: bash
       run: |
         curl -X POST '${{ inputs.webhook-url }}' -H 'Content-Type: application/json' -d '{ text: "<${{ env.RUN_URL }}|${{ inputs.run-name }}> was successful ${{ env.BUILD_SCAN }}"}' || true
-    - shell: bash
+    - name: Failure Notification
       if: ${{ inputs.status == 'failure' }}
+      shell: bash
       run: |
         curl -X POST '${{ inputs.webhook-url }}' -H 'Content-Type: application/json' -d '{ text: "<users/all> *<${{ env.RUN_URL }}|${{ inputs.run-name }}> failed* ${{ env.BUILD_SCAN }}"}' || true
-    - shell: bash
+    - name: Cancel Notification
       if: ${{ inputs.status == 'cancelled' }}
+      shell: bash
       run: |
         curl -X POST '${{ inputs.webhook-url }}' -H 'Content-Type: application/json' -d '{ text: "<${{ env.RUN_URL }}|${{ inputs.run-name }}> was cancelled"}' || true

.github/workflows/build-and-deploy-snapshot.yml

@@ -10,8 +10,8 @@ concurrency:
 jobs:
   build-and-deploy-snapshot:
     name: Build and Deploy Snapshot
-    runs-on: ubuntu-latest
     if: ${{ github.repository == 'spring-gradle-plugins/nullability-plugin' }}
+    runs-on: ubuntu-latest
     steps:
       - name: Check Out Code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -22,23 +22,23 @@ jobs:
           develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
           publish: true
       - name: Deploy
-        uses: spring-io/artifactory-deploy-action@26bbe925a75f4f863e1e529e85be2d0093cac116 # v0.0.1
+        uses: spring-io/artifactory-deploy-action@dc1913008c0599f0c4b1fdafb6ff3c502b3565ea # v0.0.2
         with:
-          uri: 'https://repo.spring.io'
-          username: ${{ secrets.ARTIFACTORY_USERNAME }}
-          password: ${{ secrets.ARTIFACTORY_PASSWORD }}
           build-name: 'nullability-plugin-0.0.x'
-          repository: 'libs-snapshot-local'
           folder: 'deployment-repository'
+          password: ${{ secrets.ARTIFACTORY_PASSWORD }}
+          repository: 'libs-snapshot-local'
           signing-key: ${{ secrets.GPG_PRIVATE_KEY }}
           signing-passphrase: ${{ secrets.GPG_PASSPHRASE }}
+          uri: 'https://repo.spring.io'
+          username: ${{ secrets.ARTIFACTORY_USERNAME }}
       - name: Send Notification
-        uses: ./.github/actions/send-notification
         if: always()
+        uses: ./.github/actions/send-notification
         with:
-          webhook-url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_URL }}
-          status: ${{ job.status }}
           build-scan-url: ${{ steps.build-and-publish.outputs.build-scan-url }}
           run-name: ${{ format('{0} | Linux | Java 17', github.ref_name) }}
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_URL }}
     outputs:
       version: ${{ steps.build-and-publish.outputs.version }}

.github/workflows/ci.yml

@@ -2,16 +2,16 @@ name: CI
 on:
   push:
     branches:
-      - main
+      - 'main'
 permissions:
   contents: read
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
 jobs:
   ci:
     name: '${{ matrix.os.name}} | Java ${{ matrix.java.version}}'
-    runs-on: ${{ matrix.os.id }}
     if: ${{ github.repository == 'spring-gradle-plugins/nullability-plugin' }}
+    runs-on: ${{ matrix.os.id }}
     strategy:
       matrix:
         os:
@@ -44,15 +44,15 @@ jobs:
         id: build
         uses: ./.github/actions/build
         with:
-          java-version: ${{ matrix.java.version }}
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
           java-distribution: ${{ matrix.java.distribution || 'liberica' }}
           java-toolchain: ${{ matrix.java.toolchain }}
-          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+          java-version: ${{ matrix.java.version }}
       - name: Send Notification
-        uses: ./.github/actions/send-notification
         if: always()
+        uses: ./.github/actions/send-notification
         with:
-          webhook-url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_URL }}
-          status: ${{ job.status }}
           build-scan-url: ${{ steps.build.outputs.build-scan-url }}
           run-name: ${{ format('{0} | {1} | Java {2}', github.ref_name, matrix.os.name, matrix.java.version) }}
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_URL }}