From 95121a09c035ac954019165d669bdd022d9a6a46 Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Tue, 29 Aug 2023 22:27:02 -0700 Subject: [PATCH] GitHub build action: check whether `mkdocs` can build docs in PRs For example, this should check for broken links from one `.md` file to another. --- .github/workflows/build.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 7e219de4ce..4df957815c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -62,6 +62,23 @@ jobs: components: rustfmt - run: cargo +nightly fmt --all -- --check + mkdocs: + name: Check that MkDocs can build the docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.11 + - name: Install poetry + uses: abatilo/actions-poetry@v2 + with: + poetry-version: latest + - name: Install dependencies + run: poetry install + - name: Check that `mkdocs` can build the docs + run: poetry run -- mkdocs build --strict + cargo-deny: runs-on: ubuntu-latest strategy: