build.yml

name: Build and check

on:
  pull_request:

permissions:
  contents: read

concurrency:
  group: 'build-doc-${{ github.ref }}'  # This ensures concurrency for the same branch or PR
  cancel-in-progress: true  # This cancels any in-progress execution when a new commit is done on the same branch

jobs:
  build-doc:
    name: Build documentation
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version: 21
      - name: Install dependencies
        run: yarn install --frozen-lockfile
      - name: Build documentation website
        # Check paths are valid, markdown, etc.
        run: yarn build
      - name: Check links
        # exceptions can be added in .lycheeignore file
        id: lychee
        uses: lycheeverse/lychee-action@885c65f3dc543b57c898c8099f4e08c8afd178a2 # v2.6.1
        with:
          fail: true
          failIfEmpty: true
          jobSummary: true
          args: build --root-dir=${{ github.workspace }}/build --verbose --no-progress --max-redirects=20