Extract Dialyzer PLT caching to custom action

Author: gaggle

.github/actions/dialyzer-cache/action.yml

@@ -0,0 +1,46 @@
+name: 'Dialyzer Cache'
+description: 'Handles caching for Dialyzer PLTs'
+inputs:
+  otp-version:
+    description: 'OTP version'
+    required: true
+  elixir-version:
+    description: 'Elixir version'
+    required: true
+  mix-lock-hash:
+    description: 'Hash of the mix.lock file, defaults to hashing `**/mix.lock`'
+    required: false
+    default: ''
+  build-plt-command:
+    description: 'The command to run to build PLT(s), defaults to `mix dialyzer --plt`'
+    default: mix dialyzer --plt
+runs:
+  using: 'composite'
+  steps:
+    - name: Calculate mix.lock hash
+      if: inputs.mix-lock-hash == ''
+      id: mix-lock-hash
+      run: echo "hash=${{ hashFiles('**/mix.lock') }}" >> $GITHUB_OUTPUT
+      shell: bash
+    - name: Restore PLT cache
+      id: restore-cache
+      uses: actions/cache/restore@v3
+      with:
+        key: |
+          plt-${{ runner.os }}-${{ inputs.otp-version }}-${{ inputs.elixir-version }}-${{ steps.mix-lock-hash.outputs.hash || inputs.mix-lock-hash }}
+        restore-keys: |
+          plt-${{ runner.os }}-${{ inputs.otp-version }}-${{ inputs.elixir-version }}-
+        path: |
+          priv/plts
+    - name: Create PLTs
+      if: steps.restore-cache.outputs.cache-hit != 'true'
+      run: ${{ inputs.build-plt-command }}
+      shell: bash
+    - name: Save PLT cache
+      if: steps.restore-cache.outputs.cache-hit != 'true'
+      uses: actions/cache/save@v3
+      with:
+        key: |
+          plt-${{ runner.os }}-${{ inputs.otp-version }}-${{ inputs.elixir-version }}-${{ steps.mix-lock-hash.outputs.hash || inputs.mix-lock-hash }}
+        path: |
+          priv/plts

.github/workflows/ci-cd.yml

@@ -46,30 +46,10 @@ jobs:
       - uses: actions/checkout@v3
       - uses: pkgxdev/dev@v0
       - run: mix deps.get
-      - name: Restore PLT cache
-        id: plt_cache
-        uses: actions/cache/restore@v3
+      - uses: ./.github/actions/dialyzer-cache
         with:
-          key: |
-            plt-${{ runner.os }}-${{ needs.version.outputs.otp-version }}-${{ needs.version.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
-          restore-keys: |
-            plt-${{ runner.os }}-${{ needs.version.outputs.otp-version }}-${{ needs.version.outputs.elixir-version }}-
-          path: |
-            priv/plts
-      - name: Create PLTs
-        if: steps.plt_cache.outputs.cache-hit != 'true'
-        run: mix dialyzer --plt
-      # By default, the GitHub Cache action will only save the cache if all steps in the job succeed,
-      # so we separate the cache restore and save steps in case running dialyzer fails.
-      - name: Save PLT cache
-        id: plt_cache_save
-        uses: actions/cache/save@v3
-        if: steps.plt_cache.outputs.cache-hit != 'true'
-        with:
-          key: |
-            plt-${{ runner.os }}-${{ needs.version.outputs.otp-version }}-${{ needs.version.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
-          path: |
-            priv/plts
+          otp-version: ${{ needs.version.outputs.otp-version }}
+          elixir-version: ${{ needs.version.outputs.elixir-version }}
       - run: bin/audit
 
   build: