# Checks for JJB documentation interest points and ensures they are documented.
-jjb_files=($(find jjb -name "*.yaml"))
+mapfile -t jjb_files < <(find jjb -name "*.yaml")
undocumented_count=0
for file in "${jjb_files[@]}"; do
- docs_interests=$(grep -e '\- builder:' \
- -e '\- job-group:' \
- -e '\- job-template:' \
- -e '\- parameter:' \
- -e '\- property:' \
- -e '\- publisher:' \
- -e '\- scm:' \
- -e '\- trigger:' \
- -e '\- wrapper:' \
- -A1 "$file" \
- | grep 'name: ' | awk -F': ' '{print $2}' | awk -F"'" '{print $2}' | sort | uniq)
+ mapfile -t docs_interests < <(grep -e '\- builder:' \
+ -e '\- job-template:' \
+ -e '\- parameter:' \
+ -e '\- property:' \
+ -e '\- publisher:' \
+ -e '\- scm:' \
+ -e '\- trigger:' \
+ -e '\- wrapper:' \
+ -A1 "$file" \
+ | grep 'name: ' | awk -F': ' '{print $2}' | sort | uniq \
+ | tr -d "'" | tr -d '"')
for item in "${docs_interests[@]}"; do
if ! grep -q "$item" "docs/${file//.yaml/.rst}"; then
- echo "$item"
- let "undocumented_count++"
+ echo "$file:$item"
+ undocumented_count=$((undocumented_count+1))
fi
done
done
-if [ $undocumented_count -gt 0 ]; then
+if [ "$undocumented_count" -gt 0 ]; then
echo "Number of undocumented items: $undocumented_count"
exit 1
fi