[ci] Display TODO errors in GitHub PR UI

gherrit-pr-id: I2d944fc641d1b3d122cf39ac5410718ecbce699c

Author: joshlf

.github/workflows/ci.yml

@@ -778,6 +778,10 @@ jobs:
     runs-on: ubuntu-latest
     name: Check for todo comments
     steps:
+      - name: Install ripgrep
+        run: |
+         sudo apt-get update
+         sudo apt-get install ripgrep
       - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
       - name: Run todo check
         run: ./ci/check_todo.sh
@@ -788,6 +792,10 @@ jobs:
     steps:
       - name: Install yq (for YAML parsing)
         run: go install github.com/mikefarah/yq/v4@latest
+      - name: Install ripgrep
+        run: |
+         sudo apt-get update
+         sudo apt-get install ripgrep
       - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
       - name: Run dependency check
         # Ensure that Git hooks execute successfully.

ci/check_todo.sh

@@ -16,6 +16,10 @@ set -euo pipefail
 # would mean that we couldn't use XODO comments in this script.
 KEYWORD=$(echo XODO | sed -e 's/X/T/')
 
+# Make sure `rg` is installed (if this fails, `set -e` above will cause the
+# script to exit).
+rg --version >/dev/null
+
 # -H: Print filename (default for multiple files/recursive)
 # -n: Print line number
 # -w: Match whole words
@@ -25,6 +29,26 @@ if [ -n "$output" ]; then
   echo "Found $KEYWORD markers in the codebase." >&2
   echo "$KEYWORD is used for tasks that should be done before merging a PR; if you want to leave a message in the codebase, use FIXME." >&2
   echo "" >&2
-  echo "$output" >&2
+  if [ "${GITHUB_ACTIONS:-false}" == "true" ]; then
+    echo "$output" | while IFS= read -r line; do
+      # Parse format `file:line: message`
+      file=$(echo "$line" | cut -d : -f 1)
+      line=$(echo "$line" | cut -d : -f 2)
+      message=$(echo "$line" | cut -d : -f 3-)
+
+      # Escape message for workflow command: % -> %25, \r -> %0D, \n -> %0A
+      message="${message//'%'/'%25'}"
+      message="${message//$'\r'/'%0D'}"
+      message="${message//$'\n'/'%0A'}"
+
+      # Output the workflow command for GitHub Actions annotations. Use `::notice`
+      # rather than `::error` so that the output is less visually distracting (the
+      # `exit 1` below will still ensure that this causes CI to fail).
+      echo "::notice file=${file},line=${line},endLine=${line},title=$KEYWORD Found::${message}"
+    done
+  else
+    echo "$output" >&2
+  fi
+
   exit 1
 fi