EXAMPLES.md

Examples

Using the official GitHub Pages actions to deploy odoc to GitHub Pages

name: Deploy odoc 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@v2
        with:
          ocaml-compiler: "5.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

Using the strategy matrix

strategy:
  fail-fast: false
  matrix:
    os:
      - macos-latest
      - ubuntu-latest
      - windows-latest
    ocaml-compiler:
      - "5.1"

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

steps:
  - name: Checkout tree
    uses: actions/checkout@v4

  - name: Set-up OCaml ${{ matrix.ocaml-compiler }}
    uses: ocaml/setup-ocaml@v2
    with:
      ocaml-compiler: ${{ matrix.ocaml-compiler }}

Using several conditional setup steps

steps:
  - name: Checkout tree
    uses: actions/checkout@v4

  - name: Set-up OCaml on Windows
    uses: ocaml/setup-ocaml@v2
    if: runner.os == 'Windows'
    with:
      opam-repositories: |
        default: https://github.com/ocaml-opam/opam-repository-mingw.git#sunset

  - name: Set-up OCaml on Unix
    uses: ocaml/setup-ocaml@v2
    if: runner.os != 'Windows'
    with:
      opam-repositories: |
        default: https://github.com/ocaml/opam-repository.git

Using a custom step to choose between the values

steps:
  - name: Checkout tree
    uses: actions/checkout@v4

  - name: Set opam repository url
    id: repository
    shell: bash
    run: |
      if [ "$RUNNER_OS" == "Windows" ]; then
        echo "::set-output name=url::https://github.com/ocaml-opam/opam-repository-mingw.git#sunset"
      elif [ "$RUNNER_OS" == "macOS" ]; then
        echo "::set-output name=url::https://github.com/custom/opam-repository.git#macOS"
      else
        echo "::set-output name=url::https://github.com/ocaml/opam-repository.git"
      fi

  - name: Set-up OCaml with repository ${{ steps.repository.outputs.url }}
    uses: ocaml/setup-ocaml@v2
    with:
      opam-repositories: |
        default: ${{ steps.repository.outputs.url }}

Using glob patterns to filter local packages

Consult the @actions/glob package for supported patterns.

steps:
  - name: Checkout tree
    uses: actions/checkout@v4

  - name: Set-up OCaml ${{ matrix.ocaml-compiler }}
    uses: ocaml/setup-ocaml@v2
    with:
      ocaml-compiler: ${{ matrix.ocaml-compiler }}
      opam-local-packages: |
        *.opam
        !exclude.opam

Using with Containers

strategy:
  fail-fast: false
  matrix:
    container:
      - debian:latest
      - ubuntu:latest
    ocaml-compiler:
      - "5.1"

container: ${{ matrix.container }}

runs-on: ubuntu-latest

steps:
  - name: Checkout tree
    uses: actions/checkout@v4

  - name: Retrieve new lists of system packages
    run: apt-get update

  - name: Install system packages
    run: apt-get --yes install bubblewrap curl darcs gcc git m4 make mercurial patch rsync sudo unzip

  - name: Set-up OCaml ${{ matrix.ocaml-compiler }}
    uses: ocaml/setup-ocaml@v2
    with:
      ocaml-compiler: ${{ matrix.ocaml-compiler }}
      cache-prefix: v1-${{ matrix.container }}
      opam-disable-sandboxing: true