The `check-whitespace` CI job generates a formatted output file
containing whitespace error information. As not all CI providers support
rendering a formatted summary, make its generation optional.
Signed-off-by: Justin Tobler <jltobler@xxxxxxxxx>
---
ci/check-whitespace.sh | 45 +++++++++++++++++++++++++++++++-----------
1 file changed, 33 insertions(+), 12 deletions(-)
diff --git a/ci/check-whitespace.sh b/ci/check-whitespace.sh
index f57d1ff5f0..fabd6ecde5 100755
--- a/ci/check-whitespace.sh
+++ b/ci/check-whitespace.sh
@@ -1,9 +1,20 @@
#!/bin/bash
+#
+# Check that commits after a specified point do not contain new or modified
+# lines with whitespace errors. An optional formatted summary can be generated
+# by providing an output file path and url as additional arguments.
+#
baseCommit=$1
outputFile=$2
url=$3
+if test "$#" -eq 0 || test "$#" -gt 3
+then
+ echo "USAGE: $0 <BASE_COMMIT> [<OUTPUT_FILE> <URL>]"
+ exit 1
+fi
+
problems=()
commit=
commitText=
@@ -56,19 +67,29 @@ then
goodParent=${baseCommit: 0:7}
fi
- echo "🛑 Please review the Summary output for further information."
- echo "### :x: A whitespace issue was found in one or more of the commits." >"$outputFile"
- echo "" >>"$outputFile"
- echo "Run these commands to correct the problem:" >>"$outputFile"
- echo "1. \`git rebase --whitespace=fix ${goodParent}\`" >>"$outputFile"
- echo "1. \`git push --force\`" >>"$outputFile"
- echo " " >>"$outputFile"
- echo "Errors:" >>"$outputFile"
+ echo "A whitespace issue was found in onen of more of the commits."
+ echo "Run the following command to resolve whitespace issues:"
+ echo "git rebase --whitespace=fix ${goodParent}"
+
+ # If target output file is provided, write formatted ouput.
+ if test -n "$outputFile"
+ then
+ echo "🛑 Please review the Summary output for further information."
+ (
+ echo "### :x: A whitespace issue was found in one or more of the commits."
+ echo ""
+ echo "Run these commands to correct the problem:"
+ echo "1. \`git rebase --whitespace=fix ${goodParent}\`"
+ echo "1. \`git push --force\`"
+ echo ""
+ echo "Errors:"
- for i in "${problems[@]}"
- do
- echo "${i}" >>"$outputFile"
- done
+ for i in "${problems[@]}"
+ do
+ echo "${i}"
+ done
+ ) >"$outputFile"
+ fi
exit 2
fi
--
2.45.0
