docs/check_links.sh

#!/usr/bin/env bash
################################################################################
#  Licensed to the Apache Software Foundation (ASF) under one
#  or more contributor license agreements.  See the NOTICE file
#  distributed with this work for additional information
#  regarding copyright ownership.  The ASF licenses this file
#  to you under the Apache License, Version 2.0 (the
#  "License"); you may not use this file except in compliance
#  with the License.  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
# limitations under the License.
################################################################################

target=${1:-"http://localhost:4000"}

# Crawl the docs, ignoring robots.txt, storing nothing locally
wget --spider -r -nd -nv -e robots=off -p -o spider.log "$target"

# Abort for anything other than 0 and 4 ("Network failure")
status=$?
if [ $status -ne 0 ] && [ $status -ne 4 ]; then
    exit $status
fi

# Fail the build if any broken links are found
broken_links_str=$(grep -e 'Found [[:digit:]]\+ broken links' spider.log)
if [ -n "$broken_links_str" ]; then
    grep -B 1 "Remote file does not exist -- broken link!!!" spider.log
    echo "---------------------------------------------------------------------------"
    echo -e "$broken_links_str"
    echo "Search for page containing broken link using 'grep -R BROKEN_PATH DOCS_DIR'"
    exit 1
fi