From fdd0dfaad46436cf88829038cbe30fe281abe2ab Mon Sep 17 00:00:00 2001 From: LukeMathWalker <20745048+LukeMathWalker@users.noreply.github.com> Date: Fri, 24 May 2024 16:26:23 +0200 Subject: [PATCH] Add CI job to verify that we have no broken links. --- .github/workflows/ci.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000..becdb9018 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,27 @@ +name: "CI" + +on: + pull_request: + branches: + - main + +jobs: + check-links: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + - name: Build API reference + run: | + cd book + curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=. + mdbook build + - name: Link Checker + uses: lycheeverse/lychee-action@v1 + with: + fail: true + args: | + --exclude-loopback + --require-https + --no-progress + book/book