Skip to content

Commit

Permalink
GitHub build action: check whether mkdocs can build docs in PRs
Browse files Browse the repository at this point in the history
For example, this should check for broken links from one `.md`
file to another.
  • Loading branch information
ilyagr committed Aug 30, 2023
1 parent 0e499dd commit 95121a0
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 95121a0

Please sign in to comment.