Skip to content

Improve accuracy and usefulness of the "No TODOs" CI workflow #142

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

Merged
rdw-software merged 3 commits into from
Nov 17, 2021
Merged

Improve accuracy and usefulness of the "No TODOs" CI workflow #142

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
838356a
CI: Ignore removed lines in the No TODOs workflow
rdw-software Nov 17, 2021
0401c0f
CI: Display more context on failed No TODO workflow runs
rdw-software Nov 17, 2021
1569a9c
CI: Ignore the checking script itself in No TODO workflow runs
rdw-software Nov 17, 2021
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
20 changes: 10 additions & 10 deletions .github/check-for-todos.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ echo "Checking for temporary comments..."

echo ""

NUMBER_OF_COMMITTED_TODOS=$(git diff HEAD origin/main | grep -o 'TODO' | wc -l)
NUMBER_OF_COMMITTED_TBDS=$(git diff HEAD origin/main | grep -o 'TBD' | wc -l)
NUMBER_OF_COMMITTED_WIPS=$(git diff HEAD origin/main | grep -o 'WIP' | wc -l)
NUMBER_OF_COMMITTED_FIXMES=$(git diff HEAD origin/main | grep -o 'FIXME' | wc -l)
NUMBER_OF_COMMITTED_HACKS=$(git diff HEAD origin/main | grep -o 'HACK' | wc -l)
NUMBER_OF_COMMITTED_TODOS=$(git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep -o 'TODO' | wc -l)
NUMBER_OF_COMMITTED_TBDS=$(git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep -o 'TBD' | wc -l)
NUMBER_OF_COMMITTED_WIPS=$(git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep -o 'WIP' | wc -l)
NUMBER_OF_COMMITTED_FIXMES=$(git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep -o 'FIXME' | wc -l)
NUMBER_OF_COMMITTED_HACKS=$(git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep -o 'HACK' | wc -l)

echo "Committed TODOs: $NUMBER_OF_COMMITTED_TODOS"
echo "Committed TBDs: $NUMBER_OF_COMMITTED_TBDS"
Expand All @@ -28,7 +28,7 @@ if [ $NUMBER_OF_COMMITTED_TODOS -ne 0 ]; then

echo "Processed git diff:"
echo ""
git diff HEAD origin/main | grep --color=always 'TODO'
git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep --color=always 'TODO' -C3

exit 1
fi
Expand All @@ -43,7 +43,7 @@ if [ $NUMBER_OF_COMMITTED_TBDS -ne 0 ]; then

echo "Processed git diff:"
echo ""
git diff HEAD origin/main | grep --color=always 'TBD'
git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep --color=always 'TBD' -C3

exit 2
fi
Expand All @@ -58,7 +58,7 @@ if [ $NUMBER_OF_COMMITTED_WIPS -ne 0 ]; then

echo "Processed git diff:"
echo ""
git diff HEAD origin/main | grep --color=always 'WIP'
git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep --color=always 'WIP' -C3

exit 3
fi
Expand All @@ -73,7 +73,7 @@ if [ $NUMBER_OF_COMMITTED_FIXMES -ne 0 ]; then

echo "Processed git diff:"
echo ""
git diff HEAD origin/main | grep --color=always 'FIXME'
git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep --color=always 'FIXME' -C3

exit 4
fi
Expand All @@ -88,7 +88,7 @@ if [ $NUMBER_OF_COMMITTED_HACKS -ne 0 ]; then

echo "Processed git diff:"
echo ""
git diff HEAD origin/main | grep --color=always 'HACK'
git diff origin/main HEAD ':(exclude).github/check-for-todos.sh' | grep ^+ | grep --color=always 'HACK' -C3

exit 5
fi
Expand Down