mirror of
https://github.com/zulip/zulip.git
synced 2025-10-24 16:43:57 +00:00
ccd0badeed
The crawler used to be called directly for checking external links. Now the scrapy command calls the crawl_with_status wrapper. Crawl_with_status has been modified to pass the external parameter in the previous commit, so we can now use this simpler approach.
63 lines
1.8 KiB
Bash
Executable File
63 lines
1.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -e
|
|
|
|
color_message () {
|
|
local color_code="$1" message="$2"
|
|
printf '\e[%sm%s\e[0m\n' "$color_code" "$message" >&2
|
|
}
|
|
|
|
loglevel=()
|
|
|
|
case $1 in
|
|
-h|--help)
|
|
echo "--help, -h show this help message and exit"
|
|
echo "--loglevel=LEVEL, -L LEVEL log level (default: ERROR)"
|
|
echo "--skip-check-links skip checking of links"
|
|
echo "--skip-external-links skip checking of external links"
|
|
exit 0
|
|
;;
|
|
-L|--loglevel)
|
|
loglevel=("$1" "$2")
|
|
;;
|
|
--skip-check-links)
|
|
skip_check_links=1
|
|
;;
|
|
--skip-external-links)
|
|
skip_external_links=1
|
|
;;
|
|
esac
|
|
|
|
cd "$(dirname "$0")"/../docs
|
|
rm -rf _build
|
|
|
|
# collapse_navigation is set to False in conf.py to improve sidebar navigation for users.
|
|
# However, we must change its value to True before we begin testing links.
|
|
# Otherwise, sphinx would generate a large number of links we don't need to test.
|
|
# The crawler would take a very long time to finish and TravisCI would fail as a result.
|
|
sphinx-build -j8 -b html -d _build/doctrees -D html_theme_options.collapse_navigation=True . _build/html
|
|
|
|
if [ -n "$skip_check_links" ]; then
|
|
color_message 94 "Skipped testing links in documentation."
|
|
exit 0
|
|
fi
|
|
|
|
cd ../tools/documentation_crawler
|
|
set +e
|
|
if [ -n "$skip_external_links" ]; then
|
|
color_message 94 "Testing only internal links in documentation..."
|
|
scrapy crawl_with_status documentation_crawler -a skip_external=set "${loglevel[@]}"
|
|
# calling crawl directly as parameter needs to be passed
|
|
else
|
|
color_message 94 "Testing links in documentation..."
|
|
scrapy crawl_with_status documentation_crawler "${loglevel[@]}"
|
|
fi
|
|
|
|
result=$?
|
|
if [ "$result" = 1 ]; then
|
|
color_message 91 "Failed!"
|
|
exit 1
|
|
else
|
|
color_message 92 "Passed!"
|
|
exit 0
|
|
fi
|