Run mdbook-linkcheck to check links in the book (#234)

.github/workflows/deploy-book.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
-          path: "book/book"
+          path: "book/book/html"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1

.github/workflows/tests.yml

@@ -127,3 +127,25 @@ jobs:
         with:
           name: mutants.out
           path: mutants.out
+
+  book:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: beta
+      - uses: Swatinem/rust-cache@v2
+      - name: Install mdbook and mdbook-linkcheck
+        uses: taiki-e/install-action@v2
+        with:
+          tool: mdbook, mdbook-linkcheck
+      - name: Build mdbook
+        run: |
+          mdbook build book
+      - name: Archive book output
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: book
+          path: book/book

.gitignore

@@ -3,3 +3,4 @@ mutants.out
 mutants.out.old
 .cargo/config.toml
 wiki
+.vscode/

book/book.toml

@@ -4,3 +4,11 @@ language = "en"
 multilingual = false
 src = "src"
 title = "cargo-mutants"
+
+[output.html]
+
+[output.linkcheck]
+follow-web-links = true
+
+[output.linkcheck.http-headers]
+'crates\.io' = ["Accept: text/html"]

book/src/ci.md

@@ -42,6 +42,3 @@ jobs:
           name: mutants-out
           path: mutants.out
 ```
-
-The workflow used by cargo-mutants on itself can be seen at
-<https://github.com/sourcefrog/cargo-mutants/blob/main/.github/workflows/mutate-self.yaml>, but this is different from what you will typically want to use, because it runs cargo-mutants from HEAD.