Merge pull request #956 from linwumingshi/ci/pr-report

ci: 👷 add PR comment notification for build and API doc generation

Author: shalousun

.github/workflows/build-and-run-example-project.yml

@@ -13,7 +13,6 @@ env:
 
 jobs:
   build:
-    if: ${{ github.repository == 'TongchengOpenSource/smart-doc' && github.event.pull_request.changed_files > 0 }} # Run this job only if there are file changes
     runs-on: ubuntu-latest
 
     steps:
@@ -338,4 +337,41 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: error-log-${{ runner.os }}-grpc-api-doc
-          path: logs
+          path: logs
+
+  write-comment:
+    if: ${{ always() }}
+    name: write comment to pr
+    needs: [build, maven-plugin-build, generate-api-docs, generate-grpc-api-doc]
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Set status message
+        id: set-status
+        run: |
+          job_status=""
+          
+          # Set the job status message
+          if [ ${{ needs.build.result }} == 'success' ] && [ ${{ needs.maven-plugin-build.result }} == 'success' ] && [ ${{ needs.generate-api-docs.result }} == 'success' ] && [ ${{ needs.generate-grpc-api-doc.result }} == 'success' ]; then
+            job_status=":green_heart: All jobs completed successfully! :tada:"
+          else
+            job_status=":x: Some jobs failed. Please check the details."
+          fi
+            
+          echo "job_status=$job_status" >> $GITHUB_ENV
+
+      - name: Comment on the pull request
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          issue-number: ${{ github.event.number }}
+          body: |
+            Pull requests [#${{ github.event.number }}](https://github.com/${{ github.repository }}/pull/${{ github.event.number }}) report:
+            ${{ env.job_status }}  
+            [DETAILS](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})
+            
+            - ${{ needs.build.result == 'success' && '✅' || '❌' }} - build: ${{ needs.build.result }}
+            - ${{ needs.maven-plugin-build.result == 'success' && '✅' || '❌' }} - maven-plugin-build: ${{ needs.maven-plugin-build.result }}
+            - ${{ needs.generate-api-docs.result == 'success' && '✅' || '❌' }} - generate-api-docs(rest, dubbo, javadoc, websocket): ${{ needs.generate-api-docs.result }}
+            - ${{ needs.generate-grpc-api-doc.result == 'success' && '✅' || '❌' }} - generate-grpc-api-doc(ubuntu-latest, macos-latest, windows-latest): ${{ needs.generate-grpc-api-doc.result }}

.github/workflows/pr-comment.yml

@@ -11,15 +11,13 @@ jobs:
       pull-requests: write
     name: Say thanks for the PR and hint to document
     steps:
-      - name: comment on the pull request
-        uses: hasura/comment-progress@v2.3.0
+      - name: Comment on the pull request
+        uses: peter-evans/create-or-update-comment@v4
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          number: ${{ github.event.number }}
-          id: thanks-and-hint-to-document
-          recreate: true
-          message: |
+          issue-number: ${{ github.event.number }}
+          body: |
             Thanks for your this PR.  :pray: 
             Please check again for your PR changes whether contains any usage configuration change such as `Add new configuration`, `Change default value of configuration`.
             If so, please add or update documents(markdown type) in `docs/` for repository [smart-doc-group/smart-doc-group.github.io](https://github.com/smart-doc-group/smart-doc-group.github.io/tree/master/docs)