book.yml

---   # MD Book generation and deployment workflow

name: zkEVM mdbook

on:
  push:
    branches: [develop, main]
  pull_request:
    branches:
      - "**"

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v3
      - uses: actions-rs/toolchain@v1
        with:
          toolchain: nightly
          override: true

      - name: Install mdbook
        uses: actions-rs/cargo@v1
        with:
          command: install
          args: mdbook

      - name: Install preprocessors
        uses: actions-rs/cargo@v1
        with:
          command: install
          args: mdbook-katex mdbook-bib mdbook-mermaid

      - name: Initialize mermaid preprocessor
        run: mdbook-mermaid install book

      - name: Build book
        run: mdbook build book

      - name: Upload built book
        uses: actions/upload-artifact@v3
        with:
          name: built-mdbook
          path: ./book/book

  deploy:
    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop')
    runs-on: ubuntu-latest
    needs: build
    steps:
      - uses: actions/checkout@v3

      - name: Download built book
        uses: actions/download-artifact@v3
        with:
          name: built-mdbook
          path: ./book/book

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./book/book