File tree 3 files changed +8
-14
lines changed
3 files changed +8
-14
lines changed Original file line number Diff line number Diff line change 15
15
runs-on : ubuntu-latest
16
16
env :
17
17
MDBOOK_VERSION : 0.4.21
18
- MDBOOK_LINKCHECK_VERSION : 0.7.6
18
+ MDBOOK_LINKCHECK2_VERSION : 0.8.1
19
19
MDBOOK_MERMAID_VERSION : 0.12.6
20
20
MDBOOK_TOC_VERSION : 0.11.2
21
21
DEPLOY_DIR : book/html
33
33
with :
34
34
path : |
35
35
~/.cargo/bin
36
- key : ${{ runner.os }}-${{ env.MDBOOK_VERSION }}--${{ env.MDBOOK_LINKCHECK_VERSION }}--${{ env.MDBOOK_TOC_VERSION }}--${{ env.MDBOOK_MERMAID_VERSION }}
36
+ key : ${{ runner.os }}-${{ env.MDBOOK_VERSION }}--${{ env.MDBOOK_LINKCHECK2_VERSION }}--${{ env.MDBOOK_TOC_VERSION }}--${{ env.MDBOOK_MERMAID_VERSION }}
37
37
38
38
- name : Cache linkcheck
39
39
uses : actions/cache@v4
52
52
if : steps.mdbook-cache.outputs.cache-hit != 'true'
53
53
run : |
54
54
cargo install mdbook --version ${{ env.MDBOOK_VERSION }}
55
- cargo install mdbook-linkcheck --version ${{ env.MDBOOK_LINKCHECK_VERSION }}
55
+ cargo install mdbook-linkcheck2 --version ${{ env.MDBOOK_LINKCHECK2_VERSION }}
56
56
cargo install mdbook-toc --version ${{ env.MDBOOK_TOC_VERSION }}
57
57
cargo install mdbook-mermaid --version ${{ env.MDBOOK_MERMAID_VERSION }}
58
58
Original file line number Diff line number Diff line change @@ -43,7 +43,7 @@ rustdocs][rustdocs].
43
43
To build a local static HTML site, install [ ` mdbook ` ] ( https://github.com/rust-lang/mdBook ) with:
44
44
45
45
```
46
- > cargo install mdbook mdbook-linkcheck mdbook-toc mdbook-mermaid
46
+ > cargo install mdbook mdbook-linkcheck2 mdbook-toc mdbook-mermaid
47
47
```
48
48
49
49
and execute the following command in the root of the repository:
@@ -56,7 +56,7 @@ The build files are found in the `book/html` directory.
56
56
57
57
### Link Validations
58
58
59
- We use ` mdbook-linkcheck ` to validate URLs included in our documentation.
59
+ We use ` mdbook-linkcheck2 ` to validate URLs included in our documentation.
60
60
` linkcheck ` will be run automatically when you build with the instructions in the section above.
61
61
62
62
### Table of Contents
Original file line number Diff line number Diff line change @@ -14,9 +14,6 @@ if [ "$GITHUB_EVENT_NAME" = "schedule" ] ; then # running in scheduled job
14
14
15
15
echo " Doing full link check."
16
16
elif [ " $GITHUB_EVENT_NAME " = " pull_request" ] ; then # running in PR CI build
17
- echo " *** WARNING: linkcheck temporarily disabled due to bugs ***"
18
- exit 0
19
-
20
17
if [ -z " $BASE_SHA " ]; then
21
18
echo " error: unexpected state: BASE_SHA must be non-empty in CI"
22
19
exit 1
@@ -28,20 +25,17 @@ elif [ "$GITHUB_EVENT_NAME" = "pull_request" ] ; then # running in PR CI build
28
25
29
26
echo " Checking files changed since $BASE_SHA : $CHANGED_FILES "
30
27
else # running locally
31
- echo " *** WARNING: linkcheck temporarily disabled due to bugs ***"
32
- exit 0
33
-
34
28
COMMIT_RANGE=master...
35
29
CHANGED_FILES=$( git diff --name-only $COMMIT_RANGE | sed ' s#^src/##' | tr ' \n' ' ' )
36
30
FLAGS=" -f $CHANGED_FILES "
37
31
38
32
echo " Checking files changed in $COMMIT_RANGE : $CHANGED_FILES "
39
33
fi
40
34
41
- echo " exec mdbook-linkcheck $FLAGS "
35
+ echo " exec mdbook-linkcheck2 $FLAGS "
42
36
if [ " $USE_TOKEN " = 1 ]; then
43
37
config=$( set_github_token)
44
- exec mdbook-linkcheck $FLAGS <<< " $config"
38
+ exec mdbook-linkcheck2 $FLAGS <<< " $config"
45
39
else
46
- exec mdbook-linkcheck $FLAGS
40
+ exec mdbook-linkcheck2 $FLAGS
47
41
fi
You can’t perform that action at this time.
0 commit comments