gh-page.yml

name: Deploy Specifications & Docs to GitHub Pages

on:
  push:
    branches: ["master"]

env:
  OCAML_VERSION: "4.14.0"
  # This version has been chosen randomly. It seems that with 2023-11-16, it is
  # broken. The compiler crashes. Feel free to pick any newer working version.
  RUST_TOOLCHAIN_VERSION: "1.72"

jobs:
  release:
    name: GitHub Pages
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Use shared Rust toolchain setting up steps
        uses: ./.github/actions/toolchain-shared
        with:
          rust_toolchain_version: ${{ env.RUST_TOOLCHAIN_VERSION }}

      - name: Use shared OCaml setting up steps
        uses: ./.github/actions/ocaml-shared
        with:
          ocaml_version: ${{ env.OCAML_VERSION }}

      # This must be the same as in the section "Generate rustdoc locally" in the README.md
      - name: Build Rust Documentation
        run: |
          eval $(opam env)
          RUSTDOCFLAGS="--enable-index-page -Zunstable-options -D warnings" cargo doc --workspace --all-features --no-deps

      - name: Build the mdbook
        run: |
          eval $(opam env)
          cd book
          make deps
          make build

      - name: Arrange website folder hierarchy
        run: |
          mv ./target/doc ./book/book/html/rustdoc

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        if: github.ref == 'refs/heads/master'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./book/book/html