copied from preCICE tutorials
This commit is contained in:
parent
46a7e98752
commit
3f1b1a6d0f
68 changed files with 156449 additions and 0 deletions
74
preCICE_tools/check.sh
Executable file
74
preCICE_tools/check.sh
Executable file
|
|
@ -0,0 +1,74 @@
|
|||
#!/bin/bash
|
||||
# Run this script at the root of the repository to check images and permalinks
|
||||
|
||||
CODE=0
|
||||
|
||||
# Check tutorials
|
||||
IGNORE="tools|quickstart"
|
||||
tutorials=$(find . -maxdepth 1 -type d -not -name ".*" | grep -vE $IGNORE | sed "s/^.\///")
|
||||
|
||||
for tutorial in $tutorials; do
|
||||
# Check permalinks
|
||||
docs=$(find "./$tutorial" -maxdepth 1 -type f -name "*.md" -print0 | xargs -0 grep -l "permalink:" | sed "s/^.\///")
|
||||
for doc in $docs; do
|
||||
link=$(grep "permalink:" "$doc" | sed "s/permalink: \+//")
|
||||
prefix="tutorials-$tutorial"
|
||||
|
||||
if ! [[ $link =~ ^$prefix ]]; then
|
||||
echo "$doc: error: wrong permalink"
|
||||
echo "$doc: note: permalink \"$link\" does not start with \"$prefix\""
|
||||
CODE=1
|
||||
else
|
||||
echo "$doc: info: correct permalink"
|
||||
echo "$doc: note: permalink is \"$link\""
|
||||
fi
|
||||
echo
|
||||
done
|
||||
|
||||
images=$(find "./$tutorial/images" -type f 2> /dev/null | sed "s/^.\///")
|
||||
prefix="tutorials-$tutorial-"
|
||||
for img in $images; do
|
||||
if ! [[ $img =~ ^$tutorial/images/$prefix ]]; then
|
||||
echo "$img: error: wrong filename"
|
||||
echo "$img: note: expected prefix \"$prefix\""
|
||||
CODE=1
|
||||
else
|
||||
echo "$img: info: correct filename"
|
||||
fi
|
||||
echo
|
||||
done
|
||||
done
|
||||
|
||||
# Check quickstart
|
||||
docs=$(find ./quickstart -maxdepth 1 -type f -name "*.md" -print0 | xargs -0 grep -l "permalink:" | sed "s/^.\///")
|
||||
for doc in $docs; do
|
||||
link=$(grep "permalink:" "$doc" | sed "s/permalink: \+//")
|
||||
prefix="quickstart"
|
||||
|
||||
if ! [[ $link =~ ^$prefix ]]; then
|
||||
echo "$doc: error: wrong permalink"
|
||||
echo "$doc: note: permalink \"$link\" does not start with \"$prefix\""
|
||||
CODE=1
|
||||
else
|
||||
echo "$doc: info: correct permalink"
|
||||
echo "$doc: note: permalink is \"$link\""
|
||||
fi
|
||||
echo
|
||||
done
|
||||
|
||||
images=$(find ./quickstart/images -type f 2> /dev/null | sed "s/^.\///")
|
||||
prefix="quickstart-"
|
||||
for img in $images; do
|
||||
if ! [[ $img =~ ^quickstart/images/$prefix ]]; then
|
||||
echo "$img: error: wrong filename"
|
||||
echo "$img: note: expected prefix \"$prefix\""
|
||||
CODE=1
|
||||
else
|
||||
echo "$img: info: correct filename"
|
||||
fi
|
||||
echo
|
||||
done
|
||||
|
||||
|
||||
[ ! "$CODE" -eq "0" ] && echo "There have been errors"
|
||||
exit $CODE
|
||||
Loading…
Add table
Add a link
Reference in a new issue