Align GitHub Actions config more closely with Spring Boot

2024-10-21 11:48:25 +01:00
parent d34584bbde
commit ef12effe9b
12 changed files with 174 additions and 126 deletions
--- a/.github/workflows/build-and-deploy-snapshot.yml
+++ b/.github/workflows/build-and-deploy-snapshot.yml
@@ -8,37 +8,38 @@ concurrency:
 jobs:
  build-and-deploy-snapshot:
    name: Build and Deploy Snapshot
-    runs-on: ubuntu-latest
    if: ${{ github.repository == 'spring-projects/spring-restdocs' }}
+    runs-on: ${{ vars.UBUNTU_MEDIUM || 'ubuntu-latest' }}
    steps:
      - name: Check Out Code
-        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        uses: actions/checkout@v4
      - name: Build and Publish
        id: build-and-publish
        uses: ./.github/actions/build
        with:
-          develocity-access-key: ${{ secrets.GRADLE_ENTERPRISE_SECRET_ACCESS_KEY }}
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+          gradle-cache-read-only: false
          publish: true
      - name: Deploy
        uses: spring-io/artifactory-deploy-action@26bbe925a75f4f863e1e529e85be2d0093cac116 # v0.0.1
        with:
-          uri: 'https://repo.spring.io'
-          username: ${{ secrets.ARTIFACTORY_USERNAME }}
-          password: ${{ secrets.ARTIFACTORY_PASSWORD }}
-          build-name: 'spring-restdocs-3.0.x'
-          repository: 'libs-snapshot-local'
-          folder: 'deployment-repository'
-          signing-key: ${{ secrets.GPG_PRIVATE_KEY }}
-          signing-passphrase: ${{ secrets.GPG_PASSPHRASE }}
          artifact-properties: |
            /**/spring-restdocs-*.zip::zip.type=docs,zip.deployed=false
+          build-name: ${{ format('spring-restdocs-{0}', github.ref_name) }}
+          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 }}
--- a/.github/workflows/build-pull-request.yml
+++ b/.github/workflows/build-pull-request.yml
@@ -1,30 +1,24 @@
 name: Build Pull Request
 on: pull_request
-
 permissions:
  contents: read
-
 jobs:
  build:
    name: Build Pull Request
-    runs-on: ubuntu-latest
    if: ${{ github.repository == 'spring-projects/spring-restdocs' }}
+    runs-on: ${{ vars.UBUNTU_MEDIUM || 'ubuntu-latest' }}
    steps:
-      - name: Set Up JDK 17
-        uses: actions/setup-java@b36c23c0d998641eff861008f374ee103c25ac73 # v4.4.0
-        with:
-          java-version: '17'
-          distribution: 'liberica'
-      - name: Check Out
-        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
-      - name: Set Up Gradle
-        uses: gradle/actions/setup-gradle@d156388eb19639ec20ade50009f3d199ce1e2808 # v4.1.0
+      - name: Check Out Code
+        uses: actions/checkout@v4
      - name: Build
-        env:
-        run: ./gradlew -Dorg.gradle.internal.launcher.welcomeMessageEnabled=false --no-daemon --no-parallel --continue build
+        id: build
+        uses: ./.github/actions/build
+      - name: Print JVM Thread Dumps When Cancelled
+        if: cancelled()
+        uses: ./.github/actions/print-jvm-thread-dumps
      - name: Upload Build Reports
-        uses: actions/upload-artifact@v4
        if: failure()
+        uses: actions/upload-artifact@v4
        with:
          name: build-reports
          path: '**/build/reports/'
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -8,12 +8,13 @@ concurrency:
 jobs:
  ci:
    name: '${{ matrix.os.name}} | Java ${{ matrix.java.version}}'
-    runs-on: ${{ matrix.os.id }}
    if: ${{ github.repository == 'spring-projects/spring-restdocs' }}
+    runs-on: ${{ matrix.os.id }}
    strategy:
+      fail-fast: false
      matrix:
        os:
-          - id: ubuntu-latest
+          - id: ${{ vars.UBUNTU_MEDIUM || 'ubuntu-latest' }}
            name: Linux
          - id: windows-latest
            name: Windows
@@ -24,6 +25,8 @@ jobs:
            toolchain: true
          - version: 22
            toolchain: true
+          - version: 23
+            toolchain: true
        exclude:
          - os:
              name: Linux
@@ -37,20 +40,22 @@ jobs:
          git config --global core.longPaths true
          Stop-Service -name Docker
      - name: Check Out Code
-        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        uses: actions/checkout@v4
      - name: Build
        id: build
        uses: ./.github/actions/build
        with:
-          java-version: ${{ matrix.java.version }}
-          java-distribution: ${{ matrix.java.distribution || 'liberica' }}
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+          gradle-cache-read-only: false
+          java-early-access: ${{ matrix.java.early-access || 'false' }}
+          java-distribution: ${{ matrix.java.distribution }}
          java-toolchain: ${{ matrix.java.toolchain }}
-          develocity-access-key: ${{ secrets.GRADLE_ENTERPRISE_SECRET_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 }}
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -8,28 +8,29 @@ concurrency:
 jobs:
  build-and-stage-release:
    name: Build and Stage Release
-    runs-on: ubuntu-latest
    if: ${{ github.repository == 'spring-projects/spring-restdocs' }}
+    runs-on: ${{ vars.UBUNTU_MEDIUIM || 'ubuntu-latest' }}
    steps:
      - name: Check Out Code
-        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        uses: actions/checkout@v4
      - name: Build and Publish
        id: build-and-publish
        uses: ./.github/actions/build
        with:
-          develocity-access-key: ${{ secrets.GRADLE_ENTERPRISE_SECRET_ACCESS_KEY }}
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+          gradle-cache-read-only: false
          publish: true
      - name: Stage Release
        uses: spring-io/artifactory-deploy-action@26bbe925a75f4f863e1e529e85be2d0093cac116 # v0.0.1
        with:
-          uri: 'https://repo.spring.io'
-          username: ${{ secrets.ARTIFACTORY_USERNAME }}
-          password: ${{ secrets.ARTIFACTORY_PASSWORD }}
-          build-name: ${{ format('spring-restdocs-{0}', steps.build-and-publish.outputs.version)}}
-          repository: 'libs-staging-local'
+          build-name: ${{ format('spring-restdocs-{0}', github.ref_name) }}
          folder: 'deployment-repository'
+          password: ${{ secrets.ARTIFACTORY_PASSWORD }}
+          repository: 'libs-staging-local'
          signing-key: ${{ secrets.GPG_PRIVATE_KEY }}
          signing-passphrase: ${{ secrets.GPG_PASSPHRASE }}
+          uri: 'https://repo.spring.io'
+          username: ${{ secrets.ARTIFACTORY_USERNAME }}
    outputs:
      version: ${{ steps.build-and-publish.outputs.version }}
  sync-to-maven-central:
@@ -37,10 +38,10 @@ jobs:
    needs:
      - build-and-stage-release
      - verify
-    runs-on: ubuntu-latest
+    runs-on: ${{ vars.UBUNTU_SMALL || 'ubuntu-latest' }}
    steps:
      - name: Check Out Code
-        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
      - name: Sync to Maven Central
        uses: ./.github/actions/sync-to-maven-central
        with:
@@ -54,23 +55,23 @@ jobs:
    needs:
      - build-and-stage-release
      - sync-to-maven-central
-    runs-on: ubuntu-latest
+    runs-on: ${{ vars.UBUNTU_SMALL || 'ubuntu-latest' }}
    steps:
      - name: Set up JFrog CLI
        uses: jfrog/setup-jfrog-cli@9fe0f98bd45b19e6e931d457f4e98f8f84461fb5 # v4.4.1
        env:
          JF_ENV_SPRING: ${{ secrets.JF_ARTIFACTORY_SPRING }}
-      - name: Promote build
+      - name: Promote Open Source Build
        run: jfrog rt build-promote ${{ format('spring-restdocs-{0}', needs.build-and-stage-release.outputs.version)}} ${{ github.run_number }} libs-release-local
  create-github-release:
    name: Create GitHub Release
    needs:
      - build-and-stage-release
      - promote-release
-    runs-on: ubuntu-latest
+    runs-on: ${{ vars.UBUNTU_SMALL || 'ubuntu-latest' }}
    steps:
      - name: Check Out Code
-        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
      - name: Create GitHub Release
        uses: ./.github/actions/create-github-release
        with: