doc.yml

name: docs workflow
on:
  push:
jobs:
  build:
    runs-on: ${{matrix.os}}
    strategy:
      fail-fast: false
      matrix:
        os:
          - macos-latest
          - ubuntu-latest
        ocaml-compiler:
          - 5.0.x
    steps:
    - name: Checkout code
      uses: actions/checkout@v3
    - name: Set up OCaml

      uses: ocaml/setup-ocaml@v2
      with:
        # Version of the OCaml compiler to initialise
        ocaml-compiler: ${{ matrix.ocaml-compiler }}

    # ppx_expect is only needed for tests, but preprocess wants to run it anyway
    - run: opam install ./cfgen.opam --deps-only --with-doc --with-test
    - run: opam exec -- dune build @doc
    - name: Upload GitHub Pages artifact
      uses: actions/upload-pages-artifact@v1.0.8
      with:
        # Artifact name
        #name: # optional, default is github-pages
        # Path of the directory containing the static assets.
        path: _build/default/_doc/_html # default is _site/
        # Duration after which artifact will expire in days.
        #retention-days: # optional, default is 1
  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      pages: write
      id-token: write
    steps:
      - name: Deploy GitHub Pages site
        uses: actions/deploy-pages@v2.0.0
        #with:
          # Should this action only emit build telemetry instead of deploying the build artifact?
          #emit_telemetry: # optional, default is false
          # The status of the previous build.
          #conclusion: # optional
          # GitHub token
          #token: # default is ${{ github.token }}
          # Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes)
          #timeout: # optional, default is 600000
          # Maximum number of status report errors before cancelling a deployment (default: 10)
          #error_count: # optional, default is 10
          # Time in milliseconds between two deployment status report (default: 5 seconds)
          #reporting_interval: # optional, default is 5000
          # Name of the artifact to deploy
          #artifact_name: # optional, default is github-pages
          # Is this attempting to deploy a pull request as a GitHub Pages preview site? (NOTE: This feature is only in alpha currently and is not available to the public!)
          #preview: # optional, default is false