Add a CI check for todo! and FIXME comments (#21950)

Motivation for this is to support writing comments that will certainly
be revisited before merge.

Release Notes:

- N/A
This commit is contained in:
Michael Sloan 2024-12-20 01:38:50 -07:00 committed by GitHub
parent e4493d60dc
commit f3fc4d6279
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 29 additions and 14 deletions

11
script/check-todos Executable file
View file

@ -0,0 +1,11 @@
#!/usr/bin/env bash
set -euo pipefail
# Brackets are used around characters so these don't show up in normal search.
pattern='tod[o]!|FIXM[E]'
result=$(git grep --no-color --ignore-case --line-number --extended-regexp -e $pattern || true)
echo "${result}"
if [[ -n "${result}" ]]; then
exit 1
fi