Add check for exec permissions and refactor lint doc script
This commit is contained in:
parent
babc1d023e
commit
6532c137a7
|
@ -3,15 +3,19 @@
|
||||||
cd "$(dirname "$0")/.."
|
cd "$(dirname "$0")/.."
|
||||||
|
|
||||||
# Use long options (e.g. --header instead of -H) for curl examples in documentation.
|
# Use long options (e.g. --header instead of -H) for curl examples in documentation.
|
||||||
grep --extended-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/
|
echo 'Checking for curl short options...'
|
||||||
|
grep --extended-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/ >/dev/null 2>&1
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
echo '✖ ERROR: Short options should not be used in documentation!' >&2
|
echo '✖ ERROR: Short options for curl should not be used in documentation!
|
||||||
|
Use long options (e.g., --header instead of -H):' >&2
|
||||||
|
grep --extended-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Ensure that the CHANGELOG.md does not contain duplicate versions
|
# Ensure that the CHANGELOG.md does not contain duplicate versions
|
||||||
DUPLICATE_CHANGELOG_VERSIONS=$(grep --extended-regexp '^## .+' CHANGELOG.md | sed -E 's| \(.+\)||' | sort -r | uniq -d)
|
DUPLICATE_CHANGELOG_VERSIONS=$(grep --extended-regexp '^## .+' CHANGELOG.md | sed -E 's| \(.+\)||' | sort -r | uniq -d)
|
||||||
|
echo 'Checking for CHANGELOG.md duplicate entries...'
|
||||||
if [ "${DUPLICATE_CHANGELOG_VERSIONS}" != "" ]
|
if [ "${DUPLICATE_CHANGELOG_VERSIONS}" != "" ]
|
||||||
then
|
then
|
||||||
echo '✖ ERROR: Duplicate versions in CHANGELOG.md:' >&2
|
echo '✖ ERROR: Duplicate versions in CHANGELOG.md:' >&2
|
||||||
|
@ -19,5 +23,16 @@ then
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Make sure no files in doc/ are executable
|
||||||
|
EXEC_PERM_COUNT=$(find doc/ -type f -perm 755 | wc -l)
|
||||||
|
echo 'Checking for executable permissions...'
|
||||||
|
if [ "${EXEC_PERM_COUNT}" -ne 0 ]
|
||||||
|
then
|
||||||
|
echo '✖ ERROR: Executable permissions should not be used in documentation! Use `chmod 644` to the files in question:' >&2
|
||||||
|
echo
|
||||||
|
find doc/ -type f -perm 755
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
echo "✔ Linting passed"
|
echo "✔ Linting passed"
|
||||||
exit 0
|
exit 0
|
||||||
|
|
Loading…
Reference in New Issue