From 12e841a994b77e8da3274c61f3dcf0b37faec4ab Mon Sep 17 00:00:00 2001 From: art-w Date: Wed, 11 Dec 2024 13:29:44 +0100 Subject: [PATCH] Automate odoc deploy (#179) --- .github/workflows/deploy-odoc.yml | 54 +++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/workflows/deploy-odoc.yml diff --git a/.github/workflows/deploy-odoc.yml b/.github/workflows/deploy-odoc.yml new file mode 100644 index 00000000..dd000a9f --- /dev/null +++ b/.github/workflows/deploy-odoc.yml @@ -0,0 +1,54 @@ +name: Deploy documentation to GitHub Pages + +on: + push: + branches: + - main + +permissions: read-all + +concurrency: + group: deploy-odoc + cancel-in-progress: true + +jobs: + deploy-odoc: + name: Deploy odoc to GitHub Pages + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + permissions: + contents: read + id-token: write + pages: write + + runs-on: ubuntu-latest + + steps: + - name: Checkout tree + uses: actions/checkout@v4 + + - name: Set-up OCaml + uses: ocaml/setup-ocaml@v3 + with: + ocaml-compiler: "5.2.1" + + - name: Install dependencies + run: opam install . --deps-only --with-doc + + - name: Build documentation + run: opam exec -- dune build @doc + + - name: Set-up Pages + uses: actions/configure-pages@v4 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: _build/default/_doc/_html + + - name: Deploy odoc to GitHub Pages + id: deployment + uses: actions/deploy-pages@v3