Add comments to PR

Author: strickvl

.github/workflows/check-links.yml

@@ -75,32 +75,69 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Create Summary
+        id: create-summary
         run: |-
           echo "# Documentation Link Check Results" >> $GITHUB_STEP_SUMMARY
 
           # Initialize FAILED variable
           FAILED=false
 
+          # Create summary content for PR comment
+          COMMENT_BODY="## Documentation Link Check Results\n\n"
+
           # Check for failures in absolute links job
           if [[ "${{ needs.check-absolute-links.outputs.exit_code }}" != "0" ]]; then
             echo "❌ **Absolute links check failed**" >> $GITHUB_STEP_SUMMARY
             echo "There are broken absolute links in the documentation. Please check the job logs for details." >> $GITHUB_STEP_SUMMARY
+            COMMENT_BODY+="❌ **Absolute links check failed**\n\nThere are broken absolute links in the documentation. [See workflow logs for details](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})\n\n"
             FAILED=true
           else
             echo "✅ **Absolute links check passed**" >> $GITHUB_STEP_SUMMARY
+            COMMENT_BODY+="✅ **Absolute links check passed**\n\n"
           fi
 
           # Check for failures in relative links job
           if [[ "${{ needs.check-relative-links.outputs.exit_code }}" != "0" ]]; then
             echo "❌ **Relative links check failed**" >> $GITHUB_STEP_SUMMARY
             echo "There are broken relative links in the documentation. Please check the job logs for details." >> $GITHUB_STEP_SUMMARY
+            COMMENT_BODY+="❌ **Relative links check failed**\n\nThere are broken relative links in the documentation. [See workflow logs for details](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})\n\n"
             FAILED=true
           else
             echo "✅ **Relative links check passed**" >> $GITHUB_STEP_SUMMARY
+            COMMENT_BODY+="✅ **Relative links check passed**\n\n"
           fi
 
+          # Add timestamp
+          COMMENT_BODY+="\n\n<sub>Last checked: $(date -u '+%Y-%m-%d %H:%M:%S UTC')</sub>"
+
+          # Save comment body to output
+          echo "comment_body<<EOF" >> $GITHUB_OUTPUT
+          echo "$COMMENT_BODY" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          # Save failed status to output
+          echo "failed=$FAILED" >> $GITHUB_OUTPUT
+
           # Exit with failure if any checks failed
           if [[ "$FAILED" == "true" ]]; then
             echo "::error::One or more link checks failed. Please fix the broken links."
             exit 1
           fi
+
+      - name: Find Comment
+        uses: peter-evans/find-comment@v2
+        if: github.event_name == 'pull_request'
+        id: find-comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: "github-actions[bot]"
+          body-includes: "Documentation Link Check Results"
+
+      - name: Create or Update Comment
+        uses: peter-evans/create-or-update-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: ${{ steps.create-summary.outputs.comment_body }}
+          edit-mode: replace