Skip to content

[ci] Display TODO errors in GitHub PR UI #2513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+23 −1
Open

[ci] Display TODO errors in GitHub PR UI #2513

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87bbb95
[ci] Display TODO errors in GitHub PR UI
joshlf Apr 25, 2025
0125106
Merge branch 'main' into I2d944fc641d1b3d122cf39ac5410718ecbce699c
joshlf Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion ci/check_todo.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ set -euo pipefail
# would mean that we couldn't use XODO comments in this script.
KEYWORD=$(echo XODO | sed -e 's/X/T/')

# TODO

# Make sure `rg` is installed (if this fails, `set -e` above will cause the
# script to exit).
rg --version >/dev/null
Expand All @@ -29,6 +31,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 output; do
# Parse format `file:line: message`
file=$(echo "$output" | cut -d : -f 1)
line=$(echo "$output" | cut -d : -f 2)
message=$(echo "$output" | 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
Loading