Update validate-formatting.yaml

.github/workflows/validate-formatting.yaml

@@ -1,4 +1,4 @@
-name: Validate and auto-fix script formatting
+name: Validate script formatting
 
 on:
   push:
@@ -11,10 +11,10 @@ on:
 
 jobs:
   shfmt:
-    name: Check and fix formatting
+    name: Check changed files
     runs-on: ubuntu-latest
     permissions:
-      contents: write
+					 
       pull-requests: write
 
     steps:
@@ -33,13 +33,13 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0 # Ensure the full history is fetched for accurate diffing
           ref: ${{ github.event_name == 'pull_request_target' && fromJSON(steps.pr.outputs.result).merge_commit_sha || '' }}
 
       - name: Get changed files
         id: changed-files
         run: |
-          if [ "${{ github.event_name }}" == "pull_request_target" ]; then
+          if ${{ github.event_name == 'pull_request_target' }}; then
               echo "files=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ steps.pr.outputs.result && fromJSON(steps.pr.outputs.result).merge_commit_sha }} | grep -E '\.(sh|func)$' | xargs)" >> $GITHUB_OUTPUT
           else
               echo "files=$(git diff --name-only ${{ github.event.before }} ${{ github.event.after }} | grep -E '\.(sh|func)$' | xargs)" >> $GITHUB_OUTPUT
@@ -55,36 +55,43 @@ jobs:
           go install mvdan.cc/sh/v3/cmd/shfmt@latest
           echo "$GOPATH/bin" >> $GITHUB_PATH
 
-      - name: Fix formatting
+      - name: Run shfmt
         if: steps.changed-files.outputs.files != ''
+        id: shfmt
         run: |
-          shfmt -w ${{ steps.changed-files.outputs.files }}
+          set +e
 
-      - name: Commit and push changes
+									 
-        if: steps.changed-files.outputs.files != '' && github.event_name == 'pull_request_target'
+          shfmt_output=$(shfmt -d ${{ steps.changed-files.outputs.files }})
-        run: |
+          if [[ $? -eq 0 ]]; then
-          git config user.name "github-actions[bot]"
+            exit 0
-          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          else
-          git add ${{ steps.changed-files.outputs.files }}
+            echo "diff=\"$(echo -n "$shfmt_output" | base64 -w 0)\"" >> $GITHUB_OUTPUT
-          git commit -m "chore: auto-fix formatting issues"
+            printf "%s" "$shfmt_output"
-          git push
+            exit 1
+          fi
 
       - name: Post comment with results
-        if: always() && github.event_name == 'pull_request_target'
+        if: always() && steps.changed-files.outputs.files != '' && github.event_name == 'pull_request_target'
         uses: actions/github-script@v7
         with:
           script: |
             const result = "${{ job.status }}" === "success" ? "success" : "failure";
+            const diff = Buffer.from(
+              ${{ steps.shfmt.outputs.diff }},
+              "base64",
+            ).toString();
             const issueNumber = context.payload.pull_request
               ? context.payload.pull_request.number
               : null;
             const commentIdentifier = "validate-formatting";
-            let newCommentBody = `<!-- ${commentIdentifier}-start -->\n### Script Formatting Results\n\n`;
+            let newCommentBody = `<!-- ${commentIdentifier}-start -->\n### Script formatting\n\n`;
 
             if (result === "failure") {
-              newCommentBody += `:x: Formatting issues were found and automatically fixed.\n`;
+              newCommentBody +=
+                `:x: We found issues in the formatting of the following changed files:\n\n\`\`\`diff\n${diff}\n\`\`\`\n`;
             } else {
-              newCommentBody += `:rocket: All scripts are properly formatted!\n`;
+              newCommentBody += `:rocket: All changed shell scripts are formatted correctly!\n`;
             }
 
             newCommentBody += `\n\n<!-- ${commentIdentifier}-end -->`;
@@ -96,11 +103,21 @@ jobs:
               });
 
               const existingComment = comments.find(
-                (comment) => comment.user.login === "github-actions[bot]" &&
+                (comment) => comment.user.login === "github-actions[bot]",
-                             comment.body.includes(commentIdentifier)
+																	 
               );
 
               if (existingComment) {
+                if (existingComment.body.includes(commentIdentifier)) {
+                  const re = new RegExp(
+                    String.raw`<!-- ${commentIdentifier}-start -->[\s\S]*?<!-- ${commentIdentifier}-end -->`,
+                    "",
+                  );
+                  newCommentBody = existingComment.body.replace(re, newCommentBody);
+                } else {
+                  newCommentBody = existingComment.body + "\n\n---\n\n" + newCommentBody;
+                }
+
                 await github.rest.issues.updateComment({
                   ...context.repo,
                   comment_id: existingComment.id,
@@ -113,3 +130,4 @@ jobs:
                   body: newCommentBody,
                 });
               }
+            }