chore: Improve the PRs of automatic updates (#1406)

Author: Jason3S

.github/actions/diff/README.md

@@ -0,0 +1,3 @@
+## `diff` Action
+
+Generate the git diff for the given files

.github/actions/diff/action.yaml

@@ -0,0 +1,25 @@
+name: diff
+description: Generate Git Diff for specified files
+
+inputs:
+  path:
+    description: Path of the files to `git diff`
+    required: false
+
+outputs:
+  diff:
+    description: The result of the git diff.
+    value: ${{ steps.diff.outputs.git_diff  }}
+
+runs:
+  using: composite
+  steps:
+    - name: Git Diff
+      id: diff
+      shell: bash
+      env:
+        FILES: ${{ inputs.path }}
+      run: |
+        echo 'git_diff<<@@GIT_STATUS@@' >> $GITHUB_OUTPUT
+        git --no-pager diff $FILES >> $GITHUB_OUTPUT
+        echo '@@GIT_STATUS@@' >> $GITHUB_OUTPUT

.github/actions/pr-body/README.md

@@ -0,0 +1,3 @@
+## `pr-body` Action
+
+Generate a PR Body based upon the file diffs. Useful for dependency updates.

.github/actions/pr-body/action.yaml

@@ -0,0 +1,66 @@
+name: gen-pr-body
+description: Generate a Pull Request body based upon the diff
+
+inputs:
+  message:
+    description: The PR message
+    required: false
+
+  title:
+    description: The title
+    required: false
+
+  path:
+    description: Path of the files to `git diff`
+    required: false
+
+outputs:
+  body:
+    description: The resulting PR Body text
+    value: ${{ steps.body.outputs.value }}
+
+runs:
+  using: composite
+  steps:
+    - name: Git Diff
+      id: diff
+      uses: ./.github/actions/diff
+      if: inputs.path
+      with:
+        path: ${{ inputs.path }}
+
+    - name: Section Diff
+      id: section-diff
+      if: inputs.path && steps.diff.outputs.diff
+      uses: streetsidesoftware/actions/public/output@v1
+      with:
+        value: |
+          ## Selected Diffs
+
+          ```diff
+          ${{ steps.diff.outputs.diff }}
+          ```
+
+    - name: Gen Summary
+      shell: bash
+      run: |
+        echo 'git_summary<<DIFF' >> $GITHUB_ENV
+        git --no-pager diff --compact-summary >> $GITHUB_ENV
+        echo 'DIFF' >> $GITHUB_ENV
+
+    - name: Body
+      id: body
+      uses: streetsidesoftware/actions/public/output@v1
+      with:
+        value: |
+          # ${{ inputs.title || 'Changes' }}
+
+          ${{ inputs.message }}
+
+          ${{ steps.section-diff.outputs.value }}
+
+          ## Summary
+
+          ```
+          ${{ env.git_summary }}
+          ```

.github/workflows/update-dependencies.yml

@@ -52,32 +52,24 @@ jobs:
           git --no-pager diff --compact-summary  --exit-code && echo "git_status=clean" >> $GITHUB_ENV || echo "git_status=dirty" >> $GITHUB_ENV
           git --no-pager diff --compact-summary
 
-      - name: Gen Body
-        run: |
-          echo 'git_body<<DIFF' >> $GITHUB_ENV
-          git --no-pager diff --compact-summary >> $GITHUB_ENV
-          echo 'DIFF' >> $GITHUB_ENV
-
-      - name: Summary
-        id: summary
-        uses: streetsidesoftware/actions/public/output@v1
+      - name: Gen PR Body
+        id: body
+        uses: ./.github/actions/pr-body
         with:
-          value: |
-            Type: ${{ env.PR_TYPE }}
+          title: Update Dependencies
+          message: |
+            **Type:** ${{ env.PR_TYPE }}
 
-            Status: ${{ steps.git-status.outputs.isDirty && 'dirty' || 'clean' }}
-            ```
-            ${{ steps.git-status.outputs.status }}
-            ```
+            **Status:** ${{ steps.git-status.outputs.isDirty && 'dirty' || 'clean' }}
+          path: >-
+            package.json
+            action-src/package.json
+            action/package.json
 
-            diff:
-            ```
-            ${{ env.git_body }}
-            ```
       - name: Show Summary
         uses: streetsidesoftware/actions/public/summary@v1
         with:
-          text: ${{ steps.summary.outputs.value }}
+          text: ${{ steps.body.outputs.body }}
 
       - name: PR
         uses: streetsidesoftware/actions/.github/actions/pr@v1
@@ -86,6 +78,6 @@ jobs:
           branch: ${{ env.NEW_BRANCH }}
           base: ${{ env.REF_BRANCH }}
           title: "${{ env.PR_TYPE }}: Workflow Bot -- Update ALL Dependencies (${{ env.REF_BRANCH }})"
-          body: ${{ steps.summary.outputs.value }}
+          body: ${{ steps.body.outputs.body }}
           app_id: ${{ secrets.AUTOMATION_APP_ID }}
           app_private_key: ${{ secrets.AUTOMATION_PRIVATE_KEY }}