name: Documentation

on:
  push:
    branches: [main]
    paths:
      - "book/**"
      - "docs/**"
      - "README.md"
      - "SECURITY.md"
      - ".github/workflows/docs.yml"
  pull_request:
    paths:
      - "book/**"
      - "docs/**"
      - "README.md"
      - "SECURITY.md"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    timeout-minutes: 15
    name: mdBook build
    runs-on: ubuntu-latest
    steps:
      - name: Harden runner
        uses: step-security/harden-runner@1d88384fd173af6ecb012dfd0264a306b711241a # v2.22.4
        with:
          egress-policy: audit
      - uses: actions/checkout@v7
      - uses: step-security/dtolnay-rust-toolchain@8dd607977d06adf4ed49b190381e74c17a9dd25f # v1.0.0
        with:
          toolchain: stable
      - name: Install mdBook
        run: cargo install mdbook --version 0.4.52 --locked
      - name: Build documentation
        run: mdbook build book