build.yml

name: LogRel CI

on:
  workflow_dispatch:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]

permissions:
  contents: read
  pages: write
  id-token: write

jobs:

  build:
    runs-on: ubuntu-latest

    env:
      coq_version: '8.16'
      ocaml_version: '4.14-flambda'
      fail-fast: true

    steps:

      - name: Checkout code
        uses: actions/checkout@v3
        with:
          submodules: true
          fetch-depth: 1

      - name: Docker-Coq-Action
        uses: coq-community/docker-coq-action@v1
        with:
          coq_version: ${{ env.coq_version }}
          ocaml_version: ${{ env.ocaml_version }}
          before_install: |
            startGroup "Print opam config"
              sudo chown -R coq:coq .
              opam config list; opam repo list; opam list
            endGroup
          before_script: |
            startGroup "Workaround permission issue"
              sudo chown -R coq:coq .  # <--
              opam exec -- ocamlfind list
            endGroup
          script: |
            startGroup "Build project"
              opam exec -- make -j 2
              opam exec -- make coqdoc
              opam exec -- make docs/dependency_graph.pre
            endGroup
          uninstall: |
            startGroup "Clean project"
            endGroup

      - name: Revert permissions
        # to avoid a warning at cleanup time
        if: ${{ always() }}
        run: sudo chown -R 1001:116 .  # <--

      - name: Install graphviz
        uses: ts-graphviz/setup-graphviz@v1

      - name: Build dependency graph
        run: |
          tred docs/dependency_graph.pre > docs/dependency_graph.dot
          dot -T png docs/dependency_graph.dot -o docs/dependency_graph.png

      - name: Build doc overview
        uses: docker://pandoc/core:2.9
        with:
          args: >-  # allows you to break string into multiple lines
            --standalone
            --output=docs/index.html
            --css=coqdoc/resources/github-pandoc.css
            --metadata title="LogRel Overview"
            docs/index.md
      - name: Setup Pages
        if: github.ref == 'refs/heads/master'
        uses: actions/configure-pages@v3
      - name: Upload artifact
        if: github.ref == 'refs/heads/master'
        uses: actions/upload-pages-artifact@v1
        with:
          path: 'docs'
      - name: Deploy to GitHub Pages
        if: github.ref == 'refs/heads/master'
        id: deployment
        uses: actions/deploy-pages@v1