Fix code formatting issues on pull request

Author: zrlw

.github/workflows/build-and-test-pr.yml

@@ -36,6 +36,9 @@ jobs:
   check-format:
     name: "Check if code needs formatting"
     runs-on: ubuntu-latest
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit the changed files back to the repository.
+      contents: write
     steps:
       - name: "Checkout"
         uses: actions/checkout@v4
@@ -64,15 +67,45 @@ jobs:
           echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
           cat mvn.log | grep "ERROR" | sed 's/Check if code needs formatting    Check if code aligns with code style   [0-9A-Z:.-]\+//' | sed 's/\[ERROR] //' | head -n -11 >> $GITHUB_STEP_SUMMARY
           echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
-          echo "Please run \`mvn spotless:apply\` to fix the formatting issues." >> $GITHUB_STEP_SUMMARY
-      - name: "Fail if code needs formatting"
+      - name: "Fix code formatting issues by using spotless:apply"
+        id: apply
         if: ${{ steps.check.outcome == 'failure' }}
-        uses: actions/github-script@v7.0.1
+        run: mvn --log-file spotless.log spotless:apply
+        continue-on-error: true
+      - name: "Upload spotless apply result"
+        if: ${{ steps.check.outcome == 'failure' }}
+        uses: actions/upload-artifact@v4
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            core.setFailed("Formatting issues found! \nRun \`mvn spotless:apply\` to fix.")
-
+          name: spotless-result
+          path: spotless.log
+      - name: "Generate Summary for successful spotless:apply"
+        if: ${{ steps.check.outcome == 'failure' && steps.apply.outcome == 'success' }}
+        run: |
+          echo ":ballot_box_with_check: Kudos! Code formatting issues are fixed by using spotless:apply!" >> $GITHUB_STEP_SUMMARY
+      - name: "Generate Summary for failed spotless:apply"
+        if: ${{ steps.check.outcome == 'failure' && steps.apply.outcome == 'failure' }}
+        run: |
+          echo "## :negative_squared_cross_mark: Code formatting issues aren't fixed by using spotless:apply!" >> $GITHUB_STEP_SUMMARY
+          echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+          cat spotless.log | grep "ERROR" | sed 's/\[ERROR] //' | head -n -11 >> $GITHUB_STEP_SUMMARY
+          echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+      - name: "Commit code formatting changes back to the PR branch"
+        id: commit
+        if: ${{ steps.check.outcome == 'failure' && steps.apply.outcome == 'success' }}
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Apply code formatting changes with Spotless"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        continue-on-error: true
+      - name: "Generate Summary for successful commit"
+        if: ${{ steps.check.outcome == 'failure' && steps.apply.outcome == 'success' &&  steps.commit.outcome == 'success'}}
+        run: |
+          echo ":ballot_box_with_check: Kudos! Code formatting changes are committed!" >> $GITHUB_STEP_SUMMARY
+      - name: "Generate Summary for failed commit"
+        if: ${{ steps.check.outcome == 'failure' && steps.apply.outcome == 'success' &&  steps.commit.outcome == 'failure'}}
+        run: |
+          echo "## :negative_squared_cross_mark: Code formatting changes aren't committed!" >> $GITHUB_STEP_SUMMARY
   license:
     name: "Check License"
     needs: check-format