build.yml

# Buildability check
# ==================
# Build dolmen using various version of the OCaml compiler
name: build

# Configure when to run the workflows. Currently only when
# it affects the `master` branch (either pushes to the branch,
# or pull request against it).
on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

jobs:
  # Build workflow
  # ==============
  # Goal: Ensure the packages builds across all supported
  # versions of the ocaml compiler.
  build:

    runs-on: ${{ matrix.os }}

    # Build Matrix
    # --------------
    strategy:
      # Do not cancel other jobs when one fails
      fail-fast: false

      matrix:
        # Operating system to run tests on.
        os:
          - ubuntu-latest

        # Ocaml versions to use
        ocaml-version:
          - ocaml-base-compiler.5.2.0

    # Build ENV
    # ---------
    env:
      # Ensure opam will not stop because it waits on some user input
      OPAMYES: "true"


    # Build/test steps
    # ----------------
    steps:
    # checkout the repo (full clone, necessary for push later)
    - name: Checkout the repo
      uses: actions/checkout@v3
    # Setup ocaml/opam
    - name: Setup ocaml/opam
      uses: avsm/setup-ocaml@v2
      with:
        ocaml-compiler: ${{ matrix.ocaml-version }}
    # Run opam udpate to get an up-to-date repo
    - name: Update opam repo
      run: opam update
    # Install ocaml deps
    - name: Install Ocaml deps
      run: opam install . --deps-only --with-test --with-doc
    # Build the package
    - name: Build the package
      run: opam exec -- make
    # Check the tests
    - name: Build the examples
      run: opam exec -- make test
    # Check the doc builds
    - name: Build the doc
      run: opam exec -- make doc

    # Update the doc
    # --------------
    - name: Deploy the dev documentation
      uses: JamesIves/github-pages-deploy-action@4.1.1
      if: github.ref == 'refs/heads/master'
      with:
        branch: gh-pages
        folder: _build/default/_doc/_html
        target-folder: dev