Skip to content

Commit 5d91437

Browse files
committed
Don't linkcheck external web links in PR CI / locally
1 parent f3d63db commit 5d91437

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

ci/linkcheck.sh

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ fi
1818
if [ "$GITHUB_EVENT_NAME" = "schedule" ] ; then # running in scheduled job
1919
FLAGS=""
2020
USE_TOKEN=1
21+
# Only follow web links for the cron job, and do not block PR CI.
22+
FOLLOW_WEB_LINKS=1
2123

2224
echo "Doing full link check."
2325
elif [ "$GITHUB_EVENT_NAME" = "pull_request" ] ; then # running in PR CI build
@@ -26,13 +28,15 @@ elif [ "$GITHUB_EVENT_NAME" = "pull_request" ] ; then # running in PR CI build
2628
exit 1
2729
fi
2830

31+
FOLLOW_WEB_LINKS=0
2932
CHANGED_FILES=$(git diff --name-only $BASE_SHA... | sed 's#^src/##' | tr '\n' ' ')
3033
FLAGS="--no-cache -f $CHANGED_FILES"
3134
USE_TOKEN=1
3235

3336
echo "Checking files changed since $BASE_SHA: $CHANGED_FILES"
3437
else # running locally
3538
COMMIT_RANGE=master...
39+
FOLLOW_WEB_LINKS=0
3640
CHANGED_FILES=$(git diff --name-only $COMMIT_RANGE | sed 's#^src/##' | tr '\n' ' ')
3741
FLAGS="-f $CHANGED_FILES"
3842

@@ -42,7 +46,7 @@ fi
4246
echo "exec $LINKCHECK_BINARY $FLAGS"
4347
if [ "$USE_TOKEN" = 1 ]; then
4448
config=$(set_github_token)
45-
exec $LINKCHECK_BINARY $FLAGS <<<"$config"
49+
exec env MDBOOK_OUTPUT__LINKCHECK__FOLLOW_WEB_LINKS=$FOLLOW_WEB_LINKS $LINKCHECK_BINARY $FLAGS <<<"$config"
4650
else
47-
exec $LINKCHECK_BINARY $FLAGS
51+
exec env MDBOOK_OUTPUT__LINKCHECK__FOLLOW_WEB_LINKS=$FOLLOW_WEB_LINKS $LINKCHECK_BINARY $FLAGS
4852
fi

0 commit comments

Comments
 (0)