gh-pages.yml

name: Deploy Github Pages

on:
  push:
    branches:
      - '*'
    paths:
      - 'README.md'
      - 'docs/**'

permissions:
  contents: read
  pages: write      # to deploy to Pages
  id-token: write   # to verify the deployment originates from an appropriate source

jobs:
  generate-docs:
    runs-on: ubuntu-latest
    container: docker.io/node:20-bullseye-slim
    timeout-minutes: 2
    steps:
      - uses: actions/checkout@v4
      - name: Setup mdBook
        run: |
          apt-get update
          apt-get install curl wget libnss3-tools -y
          mkdir mdbook
          curl -sSL https://github.com/rust-lang/mdbook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
          curl -sSL  https://github.com/tommilligan/mdbook-admonish/releases/download/v1.15.0/mdbook-admonish-v1.15.0-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
          echo `pwd`/mdbook >> $GITHUB_PATH
      - name: Build with mdBook
        run: |
          cd docs
          mdbook build
      - name: Check broken links
        env:
          INPUT_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
          INPUT_PAGES_PATH: docs/book
          INPUT_CMD_PARAMS: '--ignore-fragments --verbose --buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification'
        run: |
          wget -qO- https://raw.githubusercontent.com/ruzickap/action-my-broken-link-checker/v2/entrypoint.sh | bash
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'docs/book'

  deploy-page:
    needs: generate-docs
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    timeout-minutes: 2
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4