Add test for new README.md in docs
Prefer index.md instead since they provide clean URLs in the docs site
This commit is contained in:
parent
5523ae4915
commit
c8205203a1
|
@ -3,7 +3,7 @@
|
||||||
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.
|
||||||
echo 'Checking for curl short options...'
|
echo '=> Checking for cURL short options...'
|
||||||
grep --extended-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/ >/dev/null 2>&1
|
grep --extended-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/ >/dev/null 2>&1
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
|
@ -15,7 +15,7 @@ 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...'
|
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
|
||||||
|
@ -25,7 +25,7 @@ fi
|
||||||
|
|
||||||
# Make sure no files in doc/ are executable
|
# Make sure no files in doc/ are executable
|
||||||
EXEC_PERM_COUNT=$(find doc/ app/ -type f -perm 755 | wc -l)
|
EXEC_PERM_COUNT=$(find doc/ app/ -type f -perm 755 | wc -l)
|
||||||
echo 'Checking for executable permissions...'
|
echo '=> Checking for executable permissions...'
|
||||||
if [ "${EXEC_PERM_COUNT}" -ne 0 ]
|
if [ "${EXEC_PERM_COUNT}" -ne 0 ]
|
||||||
then
|
then
|
||||||
echo '✖ ERROR: Executable permissions should not be used in documentation! Use `chmod 644` to the files in question:' >&2
|
echo '✖ ERROR: Executable permissions should not be used in documentation! Use `chmod 644` to the files in question:' >&2
|
||||||
|
@ -33,5 +33,33 @@ then
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Do not use 'README.md', instead use 'index.md'
|
||||||
|
# Number of 'README.md's as of 2018-03-26
|
||||||
|
NUMBER_READMES_CE=42
|
||||||
|
NUMBER_READMES_EE=46
|
||||||
|
FIND_READMES=$(find doc/ -name "README.md" | wc -l)
|
||||||
|
echo '=> Checking for new README.md files...'
|
||||||
|
if [ "${CI_PROJECT_NAME}" == 'gitlab-ce' ]
|
||||||
|
then
|
||||||
|
if [ ${FIND_READMES} -ne ${NUMBER_READMES_CE} ]
|
||||||
|
then
|
||||||
|
echo
|
||||||
|
echo ' ✖ ERROR: New README.md file(s) detected, prefer index.md over README.md.' >&2
|
||||||
|
echo ' https://docs.gitlab.com/ee/development/writing_documentation.html#location-and-naming-documents'
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
elif [ "${CI_PROJECT_NAME}" == 'gitlab-ee' ]
|
||||||
|
then
|
||||||
|
if [ ${FIND_READMES} -ne $NUMBER_READMES_EE ]
|
||||||
|
then
|
||||||
|
echo
|
||||||
|
echo ' ✖ ERROR: New README.md file(s) detected, prefer index.md over README.md.' >&2
|
||||||
|
echo ' https://docs.gitlab.com/ee/development/writing_documentation.html#location-and-naming-documents'
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
echo "✔ Linting passed"
|
echo "✔ Linting passed"
|
||||||
exit 0
|
exit 0
|
||||||
|
|
Loading…
Reference in New Issue