pages.yml

name: docs

on:
  push:
    branches: ["main"]
  workflow_dispatch:

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

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    timeout-minutes: 30

    strategy:
      fail-fast: false
      matrix:
        image: ["ubuntu-22-04"]
        build: [
          {runs-on: builder, build_type: Release, enable_runtime: ON}
        ]

    runs-on:
      - in-service
      - ${{ matrix.build.runs-on }}

    container:
      image: ghcr.io/${{ github.repository }}/tt-mlir-ci-${{ matrix.image }}:latest
      options: --user root

    env:
      MDBOOK_VERSION: v0.4.40

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # Fetch all history and tags

      - name: Set reusable strings
        id: strings
        shell: bash
        run: |
          echo "work-dir=$(pwd)" >> "$GITHUB_OUTPUT"
          echo "build-output-dir=$(pwd)/build" >> "$GITHUB_OUTPUT"

      - name: Git safe dir
        run: git config --global --add safe.directory ${{ steps.strings.outputs.work-dir }}

      - name: Install mdBook
        run: |
          wget https://github.com/rust-lang/mdBook/releases/download/${MDBOOK_VERSION}/mdbook-${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz
          tar xvf mdbook-${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5

      - name: Build the docs
        shell: bash
        run: |
          source env/activate
          export PATH="$PATH:${{ steps.strings.outputs.work-dir }}"
          cmake -B build -S ${{ steps.strings.outputs.work-dir }}
          cmake --build build -- doxygen

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./build/docs/book

  # 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@v4