CI/docs: update comments when the links in the docs are valid

Author: dannywillems

.github/scripts/verify-code-references.sh

@@ -182,6 +182,22 @@ echo ""
 
 if [[ $EXIT_CODE -eq 0 ]]; then
     echo -e "${GREEN}✓ All code references are valid!${NC}"
+
+    # If in PR comment mode, write success message to file
+    if [[ -n "${COMMENT_FILE}" ]]; then
+        cat > "${COMMENT_FILE}" <<EOF
+## ✓ Code Reference Verification Passed
+
+All code references in the documentation have been verified successfully!
+
+**Total references checked:** ${TOTAL_REFS}
+**Valid references:** ${VALID_REFS}
+
+The documentation is in sync with the codebase on the \`develop\` branch.
+EOF
+        echo ""
+        echo "PR success comment written to: ${COMMENT_FILE}"
+    fi
 else
     echo -e "${RED}✗ Some code references are invalid. Please update the documentation.${NC}"
 

.github/workflows/docs.yaml

@@ -57,16 +57,16 @@ jobs:
         run: |
           bash .github/scripts/verify-code-references.sh --pr-comment /tmp/pr-comment.md
           if [ -f /tmp/pr-comment.md ]; then
-            echo "has_errors=true" >> $GITHUB_OUTPUT
+            echo "has_comment=true" >> $GITHUB_OUTPUT
             echo "Comment file created, will post to PR"
             cat /tmp/pr-comment.md
           else
-            echo "has_errors=false" >> $GITHUB_OUTPUT
-            echo "No errors found, no comment needed"
+            echo "has_comment=false" >> $GITHUB_OUTPUT
+            echo "No comment file created"
           fi
 
-      - name: Comment PR on verification failure
-        if: github.event_name == 'pull_request' && steps.verify-pr.outputs.has_errors == 'true'
+      - name: Comment PR with verification results
+        if: github.event_name == 'pull_request' && steps.verify-pr.outputs.has_comment == 'true'
         uses: thollander/actions-comment-pull-request@v3
         with:
           file-path: /tmp/pr-comment.md