feat: Add more/better logging

Author: smockle

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

@@ -29,24 +29,31 @@ runs:
         path: ${{ inputs.key }}
         token: ${{ inputs.token }}
         fail_on_cache_miss: ${{ inputs.fail_on_cache_miss }}
+
     - if: ${{ inputs.value }}
       name: Update cached value
       shell: bash
       run: |
         mkdir -p "$(dirname "${{ inputs.key }}")"
         echo '${{ inputs.value }}' > "${{ inputs.key }}"
+        echo "Updated contents of '${{ inputs.key }}'"
+
     - if: ${{ inputs.value }}
       name: Save cached value
       uses: github/continuous-accessibility-scanner/.github/actions/gh-cache/save@smockle/cache-findings
       with:
         path: ${{ inputs.key }}
         token: ${{ inputs.token }}
+
     - name: Output cached value
       shell: bash
       run: |
         echo "value<<EOF" >> $GITHUB_OUTPUT
         if [ -f "${{ inputs.key }}" ]; then
           cat "${{ inputs.key }}" >> $GITHUB_OUTPUT
+          echo "Outputted 'value: $(cat "${{ inputs.key }}")'"
+        else
+          echo "Skipped outputting 'value'"
         fi
         echo "EOF" >> $GITHUB_OUTPUT
 

.github/actions/gh-cache/restore/action.yml

@@ -28,11 +28,14 @@ runs:
       working-directory: .gh-cache-${{ github.run_id }}
       run: |
         if git ls-remote --exit-code --heads origin gh-cache >/dev/null; then
-          git fetch origin gh-cache:gh-cache
-          git checkout gh-cache
-        elif [[ "${{ inputs.fail_on_cache_miss }}" == "true" ]]; then
-          echo "Branch does not exist and 'fail_on_cache_miss' is 'true'."
-          exit 1
+          git fetch origin gh-cache:gh-cache >/dev/null 2>&1
+          git checkout gh-cache >/dev/null 2>&1
+        else
+          echo "Branch 'gh-cache' does not exist"
+          if [[ "${{ inputs.fail_on_cache_miss }}" == "true" ]]; then
+            echo "Exiting with error because 'fail_on_cache_miss' is 'true'"
+            exit 1
+          fi
         fi
 
     - name: Restore cached item
@@ -43,9 +46,13 @@ runs:
         if [ -e "$src" ]; then
           mkdir -p "$(dirname "$dest")"
           cp -Rf "$src" "$dest"
-        elif [[ "${{ inputs.fail_on_cache_miss }}" == "true" ]]; then
-          echo "File or directory does not exist and 'fail_on_cache_miss' is 'true'."
-          exit 1
+          echo "Restored '${{ inputs.path }}' from cache"
+        else
+          echo "'${{ inputs.path }}' not found in cache"
+          if [[ "${{ inputs.fail_on_cache_miss }}" == "true" ]]; then
+            echo "Exiting with error because 'fail_on_cache_miss' is 'true'"
+            exit 1
+          fi
         fi
 
     - name: Clean up temporary directory

.github/actions/gh-cache/save/action.yml

@@ -24,17 +24,20 @@ runs:
       working-directory: .gh-cache-${{ github.run_id }}
       run: |
         if git ls-remote --exit-code --heads origin gh-cache >/dev/null; then
-          git checkout gh-cache
+          git checkout gh-cache >/dev/null 2>&1
+          echo "Checked out existing 'gh-cache' branch"
         else
-          git checkout --orphan gh-cache
+          git checkout --orphan gh-cache >/dev/null 2>&1
           git rm -rfq . # Clear files from the initial checkout, to avoid adding them to the orphaned branch
+          echo "Created new orphaned 'gh-cache' branch"
         fi
 
     - name: Copy file to repo
       shell: bash
       run: |
         if [ -f "${{ inputs.path }}" ]; then
           cp -Rf "${{ inputs.path }}" ".gh-cache-${{ github.run_id }}/${{ inputs.path }}"
+          echo "Copied '${{ inputs.path }}' to 'gh-cache' branch"
         fi
 
     - name: Commit and push
@@ -45,8 +48,13 @@ runs:
           git add "${{ inputs.path }}"
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
-          git commit -m "$(printf 'Save artifact: %s' "${{ inputs.path }}")" || echo "No changes to commit"
+          git commit -m "$(printf 'Save artifact: %s' "${{ inputs.path }}")" \
+            && echo "Committed '${{ inputs.path }}' to 'gh-cache' branch" \
+            || echo "No changes to commit"
           git push origin gh-cache
+        else
+          echo "'${{ inputs.path }}' does not exist"
+          echo "Skipping commit and push"
         fi
 
     - name: Clean up temporary directory