deploy.yml

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# Sample workflow for building and deploying a static site to GitHub Pages
name: Deploy docs site to Pages

env:
  RUSTKYLL_VERSION: v0.4.6
  RUSTKYLL_LINUX_AMD64_SHA256: 8a8d05b5056cb34bd59a76f7952be48e7d6cb93782821c4a688f13a7908185f5

on:
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
      - name: Install Rustkyll
        run: |
          mkdir -p .bin
          curl -fsSL \
            "https://github.com/alexeygrigorev/rustkyll/releases/download/${RUSTKYLL_VERSION}/rustkyll-linux-amd64" \
            -o .bin/rustkyll
          echo "${RUSTKYLL_LINUX_AMD64_SHA256}  .bin/rustkyll" | sha256sum -c -
          chmod +x .bin/rustkyll
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v6
      - name: Build with Rustkyll
        # Outputs to the './_site' directory by default
        run: .bin/rustkyll build --baseurl "${{ steps.pages.outputs.base_path }}"
        env:
          JEKYLL_ENV: production
      - name: Verify Pages base path
        run: |
          base_path="${{ steps.pages.outputs.base_path }}"
          if [ -n "$base_path" ]; then
            grep -q "href=\"$base_path/assets/css/just-the-docs-default.css\"" _site/index.html
            grep -q "src=\"$base_path/assets/js/vendor/lunr.min.js\"" _site/index.html
          fi
      - name: Upload artifact
        # Automatically uploads an artifact from the './_site' directory by default
        uses: actions/upload-pages-artifact@v5
        with:
          path: _site

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5