documentation.yaml

name: Documentation checks

on:
  push:
    branches: main
  pull_request:
    branches: main
    paths:
      - 'docs/**'
      - 'spellingstyles/**'

jobs:
  link_check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Link check
        uses: gaurav-nelson/github-action-markdown-link-check@v1
        with:
          config-file: .github/md_config.json
  spell_check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Spell check
        uses: errata-ai/vale-action@v2.0.1
        with:
          styles: https://github.com/errata-ai/write-good/releases/latest/download/write-good.zip
          files: docs/src
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
  build_and_deploy:
    runs-on: ubuntu-latest
    concurrency:
      group: ${{github.workflow}}-${{github.ref}}
    steps:
      - uses: actions/checkout@v3
      - name: Setup mdBook
        uses: peaceiris/actions-mdbook@v1
        with:
          mdbook-version: 0.4.13
      - run: mdbook build ./docs
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{github.ref == 'refs/heads/main'}}
        with:
          github_token: ${{secrets.GITHUB_TOKEN}}
          publish_dir: ./docs/book