gitlab-org--gitlab-foss/scripts/lint-doc.sh
Robert Speicher 9f7a7115a4 Convert CHANGELOG to Markdown
All this does is convert the version sections into headers. The list
items shouldn't really be indented by two spaces, but it makes no
difference to the rendering and this way we retain authorship history
for the actual changes.

Related to https://gitlab.com/gitlab-org/release-tools/merge_requests/29
2016-10-16 21:05:24 +02:00

24 lines
701 B
Bash
Executable file

#!/usr/bin/env bash
cd "$(dirname "$0")/.."
# Use long options (e.g. --header instead of -H) for curl examples in documentation.
grep --perl-regexp --recursive --color=auto 'curl (.+ )?-[^- ].*' doc/
if [ $? == 0 ]
then
echo '✖ ERROR: Short options should not be used in documentation!' >&2
exit 1
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)
if [ "${DUPLICATE_CHANGELOG_VERSIONS}" != "" ]
then
echo '✖ ERROR: Duplicate versions in CHANGELOG.md:' >&2
echo "${DUPLICATE_CHANGELOG_VERSIONS}" >&2
exit 1
fi
echo "✔ Linting passed"
exit 0