Skip to content

Commit 637ad77

Browse files
committed
Don't linkcheck external web links in PR CI
1 parent f3d63db commit 637ad77

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

ci/linkcheck.sh

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ fi
1818
if [ "$GITHUB_EVENT_NAME" = "schedule" ] ; then # running in scheduled job
1919
FLAGS=""
2020
USE_TOKEN=1
21+
FOLLOW_WEB_LINKS="true"
2122

2223
echo "Doing full link check."
2324
elif [ "$GITHUB_EVENT_NAME" = "pull_request" ] ; then # running in PR CI build
@@ -26,13 +27,18 @@ elif [ "$GITHUB_EVENT_NAME" = "pull_request" ] ; then # running in PR CI build
2627
exit 1
2728
fi
2829

30+
# External links should not block PR CI because they can fail due to network
31+
# conditions or server conditions of the external links, which is beyond the
32+
# control of contributors.
33+
FOLLOW_WEB_LINKS="false"
2934
CHANGED_FILES=$(git diff --name-only $BASE_SHA... | sed 's#^src/##' | tr '\n' ' ')
3035
FLAGS="--no-cache -f $CHANGED_FILES"
3136
USE_TOKEN=1
3237

3338
echo "Checking files changed since $BASE_SHA: $CHANGED_FILES"
3439
else # running locally
3540
COMMIT_RANGE=master...
41+
FOLLOW_WEB_LINKS="true"
3642
CHANGED_FILES=$(git diff --name-only $COMMIT_RANGE | sed 's#^src/##' | tr '\n' ' ')
3743
FLAGS="-f $CHANGED_FILES"
3844

@@ -42,7 +48,7 @@ fi
4248
echo "exec $LINKCHECK_BINARY $FLAGS"
4349
if [ "$USE_TOKEN" = 1 ]; then
4450
config=$(set_github_token)
45-
exec $LINKCHECK_BINARY $FLAGS <<<"$config"
51+
exec env MDBOOK_OUTPUT__LINKCHECK__FOLLOW_WEB_LINKS=$FOLLOW_WEB_LINKS $LINKCHECK_BINARY $FLAGS <<<"$config"
4652
else
47-
exec $LINKCHECK_BINARY $FLAGS
53+
exec env MDBOOK_OUTPUT__LINKCHECK__FOLLOW_WEB_LINKS=$FOLLOW_WEB_LINKS $LINKCHECK_BINARY $FLAGS
4854
fi

0 commit comments

Comments
 (0)