diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-12 21:09:45 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-12 21:09:45 +0000 |
commit | dd4bee69b7d55620f7dc9db8c36b478bd4959755 (patch) | |
tree | 78ba4c486ad8aa2d5effaccf23241ffb6c6dde26 /scripts/lint-doc.sh | |
parent | ce8a0b90849ac5d1895e741c023432930f24d724 (diff) | |
download | gitlab-ce-dd4bee69b7d55620f7dc9db8c36b478bd4959755.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'scripts/lint-doc.sh')
-rwxr-xr-x | scripts/lint-doc.sh | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/scripts/lint-doc.sh b/scripts/lint-doc.sh index d9440a5f052..d9de48fd0c0 100755 --- a/scripts/lint-doc.sh +++ b/scripts/lint-doc.sh @@ -2,36 +2,41 @@ cd "$(dirname "$0")/.." echo "=> Linting documents at path $(pwd) as $(whoami)..." +echo +ERRORCODE=0 # Use long options (e.g. --header instead of -H) for curl examples in documentation. echo '=> Checking for cURL short options...' +echo grep --extended-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/ >/dev/null 2>&1 if [ $? -eq 0 ] then 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 + ((ERRORCODE++)) fi # 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) echo '=> Checking for CHANGELOG.md duplicate entries...' +echo if [ "${DUPLICATE_CHANGELOG_VERSIONS}" != "" ] then echo '✖ ERROR: Duplicate versions in CHANGELOG.md:' >&2 echo "${DUPLICATE_CHANGELOG_VERSIONS}" >&2 - exit 1 + ((ERRORCODE++)) fi # Make sure no files in doc/ are executable EXEC_PERM_COUNT=$(find doc/ -type f -perm 755 | wc -l) echo "=> Checking $(pwd)/doc for executable permissions..." +echo 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 find doc/ -type f -perm 755 - exit 1 + ((ERRORCODE++)) fi # Do not use 'README.md', instead use 'index.md' @@ -39,13 +44,14 @@ fi NUMBER_READMES=46 FIND_READMES=$(find doc/ -name "README.md" | wc -l) echo '=> Checking for new README.md files...' +echo if [ ${FIND_READMES} -ne $NUMBER_READMES ] then echo echo ' ✖ ERROR: New README.md file(s) detected, prefer index.md over README.md.' >&2 echo ' https://docs.gitlab.com/ee/development/documentation/styleguide.html#work-with-directories-and-files' echo - exit 1 + ((ERRORCODE++)) fi MD_DOC_PATH=${MD_DOC_PATH:-doc} @@ -64,7 +70,7 @@ function run_locally_or_in_docker() { echo echo " ✖ ERROR: '${cmd}' not found. Install '${cmd}' or Docker to proceed." >&2 echo - exit 1 + ((ERRORCODE++)) fi if [ $? -ne 0 ] @@ -72,15 +78,22 @@ function run_locally_or_in_docker() { echo echo " ✖ ERROR: '${cmd}' failed with errors." >&2 echo - exit 1 + ((ERRORCODE++)) fi } echo '=> Linting markdown style...' +echo run_locally_or_in_docker 'markdownlint' "--config .markdownlint.json ${MD_DOC_PATH}" echo '=> Linting prose...' run_locally_or_in_docker 'vale' "--minAlertLevel error ${MD_DOC_PATH}" -echo "✔ Linting passed" -exit 0 +if [ $ERRORCODE -ne 0 ] +then + echo "✖ ${ERRORCODE} lint test(s) failed. Review the log carefully to see full listing." + exit 1 +else + echo "✔ Linting passed" + exit 0 +fi |