Refactor workflows with YAML anchors for common patterns

Copilot · SimplyDanny · Copilot · commit 7f063dc3ca62 · 2025-10-18T11:11:00.000Z
Co-authored-by: SimplyDanny &lt;16365760+SimplyDanny@users.noreply.github.com&gt;
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -8,14 +8,18 @@ on:
 permissions:
   contents: read
 
+# Common reusable configurations
+x-checkout-step: &checkout-step
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    persist-credentials: false
+
 jobs:
   bazel_linux:
     name: Bazel, Linux, Swift 6.2 # pre-installed
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+      - *checkout-step
       - uses: ./.github/actions/bazel-linux-build
         name: Build SwiftLint with Bazel
         env:
@@ -40,9 +44,7 @@ jobs:
             version: '6.2'
     container: ${{ matrix.image }}
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+      - *checkout-step
       - name: Build plugins
         uses: ./.github/actions/run-make
         with:
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -15,6 +15,20 @@ on:
         required: true
         type: string
 
+# Common reusable configurations
+x-checkout-step-pr: &checkout-step-pr
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  if: needs.set-context.outputs.checkout-ref == 'pr'
+  with:
+    persist-credentials: false
+
+x-checkout-step-ref: &checkout-step-ref
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  if: needs.set-context.outputs.checkout-ref != 'pr'
+  with:
+    ref: ${{ needs.set-context.outputs.checkout-ref }}
+    persist-credentials: false
+
 jobs:
   set-context:
     name: Set Context
@@ -57,15 +71,8 @@ jobs:
       packages: write
     needs: set-context
     steps:
-    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-      if: needs.set-context.outputs.checkout-ref == 'pr'
-      with:
-        persist-credentials: false
-    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-      if: needs.set-context.outputs.checkout-ref != 'pr'
-      with:
-        ref: ${{ needs.set-context.outputs.checkout-ref }}
-        persist-credentials: false
+    - *checkout-step-pr
+    - *checkout-step-ref
     - uses: ./.github/actions/docker-build
       with:
         platform: amd64
@@ -79,15 +86,8 @@ jobs:
       packages: write
     needs: set-context
     steps:
-    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-      if: needs.set-context.outputs.checkout-ref == 'pr'
-      with:
-        persist-credentials: false
-    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-      if: needs.set-context.outputs.checkout-ref != 'pr'
-      with:
-        ref: ${{ needs.set-context.outputs.checkout-ref }}
-        persist-credentials: false
+    - *checkout-step-pr
+    - *checkout-step-ref
     - uses: ./.github/actions/docker-build
       with:
         platform: arm64
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -5,16 +5,32 @@ on:
     branches: [main]
   pull_request:
 
+# Common reusable configurations
+x-checkout-step: &checkout-step
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    persist-credentials: false
+
+x-swift-version-step: &swift-version-step
+  name: Get Swift version
+  id: swift_version
+  run: echo "version=$(swift --version | grep '[5-9]\.[0-9]\+\(\.[0-9]\)\?' -o | head -1)" >> "$GITHUB_OUTPUT"
+
+x-cache-step-linux: &cache-step-linux
+  uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+  with:
+    key: ${{ runner.os }}-spm-${{ steps.swift_version.outputs.version }}-${{ hashFiles('Package.resolved', 'Package.swift') }}
+    restore-keys: ${{ runner.os }}-spm-${{ steps.swift_version.outputs.version }}-
+    path: .build
+
 jobs:
   create-docs:
     name: Create
     runs-on: ubuntu-24.04
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+      - *checkout-step
       - uses: ruby/setup-ruby@ab177d40ee5483edb974554986f56b33477e21d0 # v1.265.0
         with:
           bundler-cache: true
@@ -24,14 +40,8 @@ jobs:
           target: "//:swiftlint @SourceKittenFramework//:sourcekitten"
         env:
           CI_BAZELRC_FILE_CONTENT: ${{ secrets.CI_BAZELRC_FILE_CONTENT }}
-      - name: Get Swift version
-        id: swift_version
-        run: echo "version=$(swift --version | grep '[5-9]\.[0-9]\+\(\.[0-9]\)\?' -o | head -1)" >> "$GITHUB_OUTPUT"
-      - uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
-        with:
-          key: ${{ runner.os }}-spm-${{ steps.swift_version.outputs.version }}-${{ hashFiles('Package.resolved', 'Package.swift') }}
-          restore-keys: ${{ runner.os }}-spm-${{ steps.swift_version.outputs.version }}-
-          path: .build
+      - *swift-version-step
+      - *cache-step-linux
       - name: Generate documentation
         run: |
           export PATH="/usr/share/swift/usr/bin:$PATH"
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -7,14 +7,18 @@ permissions:
   contents: read
   pull-requests: write
 
+# Common reusable configurations
+x-checkout-step: &checkout-step
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    persist-credentials: false
+
 jobs:
   lint-swift:
     name: Swift
     runs-on: ubuntu-24.04 # "Noble Numbat"
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+      - *checkout-step
       - uses: ./.github/actions/bazel-linux-build
         name: Build SwiftLint with Bazel
         env:
@@ -25,9 +29,7 @@ jobs:
     name: Markdown
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+      - *checkout-step
       - name: Lint
         uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # v20.0.0
         with:
@@ -39,9 +41,7 @@ jobs:
     name: Actions
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+      - *checkout-step
       - name: Register problem matcher
         run: |
           curl -sSL https://raw.githubusercontent.com/rhysd/actionlint/main/.github/actionlint-matcher.json > actionlint-matcher.json
diff --git a/.github/workflows/plugins-sync.yml b/.github/workflows/plugins-sync.yml
@@ -11,15 +11,19 @@ on:
 permissions:
   contents: read
 
+# Common reusable configurations
+x-checkout-step: &checkout-step
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    persist-credentials: false
+
 jobs:
   sync:
     name: Sync Plugins Folder
     runs-on: ubuntu-24.04
     steps:
       - name: Checkout repository
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+        <<: *checkout-step
       - name: Run file sync
         uses: BetaHuhn/repo-file-sync-action@8b92be3375cf1d1b0cd579af488a9255572e4619 # v1.21.1
         with:
diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml
@@ -4,6 +4,12 @@ on:
   release:
     types: published
 
+# Common reusable configurations
+x-checkout-step: &checkout-step
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    persist-credentials: false
+
 jobs:
   setup-credentials:
     name: Setup Actor Credentials
@@ -48,10 +54,9 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - <<: *checkout-step
         with:
           ref: ${{ github.event.release.tag_name }}
-          persist-credentials: false
       - name: Deploy to CocoaPods
         run: make pod_publish
         env:
@@ -66,10 +71,9 @@ jobs:
       contents: read
     steps:
       - name: Checkout repository
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        <<: *checkout-step
         with:
           ref: ${{ github.event.release.tag_name }}
-          persist-credentials: false
       - name: Parse checksum
         id: parse_checksum
         run: echo "checksum=$(grep -o '[a-fA-F0-9]\{64\}' Package.swift)" >> "$GITHUB_OUTPUT"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -16,6 +16,21 @@ env:
   DEVELOPER_DIR: /Applications/Xcode_26.0.1.app
   RELEASE_BRANCH: release/${{ inputs.version }}
 
+# Common reusable configurations
+x-checkout-step: &checkout-step
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    persist-credentials: false
+
+x-checkout-release-branch: &checkout-release-branch
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    ref: ${{ env.RELEASE_BRANCH }}
+    persist-credentials: false
+
+x-upload-artifact: &upload-artifact
+  uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+
 jobs:
   setup-credentials:
     name: Setup Actor Credentials
@@ -69,9 +84,7 @@ jobs:
       contents: read
     steps:
       - name: Checkout repository
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+        <<: *checkout-step
       - name: Set up Ruby and Bundler
         uses: ruby/setup-ruby@ab177d40ee5483edb974554986f56b33477e21d0 # v1.265.0
         with:
@@ -103,16 +116,13 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          ref: ${{ env.RELEASE_BRANCH }}
-          persist-credentials: false
+      - <<: *checkout-release-branch
       - name: Install dependencies
         run: sudo apt-get install -y libcurl4-openssl-dev libxml2-dev
       - name: Build binary
         run: make --debug spm_linux_build
       - name: Upload binary
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        <<: *upload-artifact
         with:
           name: ${{ matrix.artifact_name }}
           path: .build/release/swiftlint
@@ -138,10 +148,7 @@ jobs:
     env:
       BINARY_PATH: .build/${{ matrix.swift_sdk }}/release/swiftlint
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          ref: ${{ env.RELEASE_BRANCH }}
-          persist-credentials: false
+      - <<: *checkout-release-branch
       - name: Install SDK
         run: swift sdk install https://download.swift.org/swift-6.2-release/static-sdk/swift-6.2-RELEASE/swift-6.2-RELEASE_static-linux-0.0.1.artifactbundle.tar.gz --checksum d2225840e592389ca517bbf71652f7003dbf45ac35d1e57d98b9250368769378
       - name: Build static binary
@@ -155,7 +162,7 @@ jobs:
       - name: Strip binary
         run: strip -s "$BINARY_PATH"
       - name: Upload artifact
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        <<: *upload-artifact
         with:
           name: ${{ matrix.artifact_name }}
           path: ${{ env.BINARY_PATH }}
@@ -167,14 +174,11 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          ref: ${{ env.RELEASE_BRANCH }}
-          persist-credentials: false
+      - <<: *checkout-release-branch
       - name: Build SwiftLint for macOS
         run: make --debug bazel_release
       - name: Upload build artifacts
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        <<: *upload-artifact
         with:
           name: swiftlint-macos
           path: |
diff --git a/.github/workflows/stale-issues.yml b/.github/workflows/stale-issues.yml
@@ -8,14 +8,18 @@ on:
 permissions:
   issues: write
 
+# Common reusable configurations
+x-checkout-step: &checkout-step
+  uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+  with:
+    persist-credentials: false
+
 jobs:
   close-stale-issues:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        with:
-          persist-credentials: false
+        <<: *checkout-step
       - name: Mark or close stale issues
         run: |
           ./tools/stale-issues.rb ${{ github.repository }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
