setup-ocaml/action.yml at master · ocaml/setup-ocaml · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
name: Set up OCaml
description: Set up an OCaml and opam environment and add to PATH
author: Anil Madhavapeddy
branding:
  icon: package
  color: orange
inputs:
  ocaml-compiler:
    description: >-
      The OCaml compiler packages to initialise. Accepts a semver version
      range (e.g. "5.3", "4.14.x") which is resolved to the latest
      matching version from opam-repository, or a full opam package name
      (e.g. "ocaml-variants.5.3.0+options,ocaml-option-flambda").
    required: true
  opam-repositories:
    description: >-
      A YAML mapping of opam repository name/URL pairs to use. Repositories
      listed first take priority over later ones. The default is the
      official opam-repository. Set this to add custom or overlay
      repositories (e.g. "custom: https://my-repo.example.com").
    required: false
    default: |
      default: git+https://github.com/ocaml/opam-repository.git
  opam-pin:
    description: >-
      Automatically pin local opam packages (matched by
      "opam-local-packages") in the opam switch. Set to "false" to skip
      pinning.
    required: false
    default: "true"
  opam-local-packages:
    description: >-
      A glob pattern matching the local .opam files to be pinned when
      "opam-pin" is enabled. The default "*.opam" matches all .opam files
      in the repository root.
    required: false
    default: "*.opam"
  opam-disable-sandboxing:
    description: >-
      Disable the opam sandboxing feature. opam uses Bubblewrap on Linux
      and sandbox-exec on macOS. This is useful for self-hosted
      runners where the sandbox tool is not available. On Windows,
      sandboxing is always disabled regardless of this setting.
    required: false
    default: "false"
  dune-cache:
    description: >-
      Enable Dune build caching via GitHub Actions cache. When enabled,
      the Dune cache directory is saved and restored between workflow runs
      to speed up incremental builds.
    required: false
    default: "false"
  cache-prefix:
    description: >-
      The prefix used for all cache keys. Change this value
      to force a cache invalidation when the cache becomes corrupted or
      stale.
    required: false
    default: v3
  windows-compiler:
    description: >-
      The C compiler toolchain used for building on Windows.
      Use "mingw" (default) for mingw-w64 (GCC), or "msvc" for the
      Microsoft Visual C compiler. MSVC requires Visual Studio on the
      runner (pre-installed on GitHub-hosted runners).
    required: false
    default: mingw
  windows-environment:
    description: >-
      The Unix environment used for building on Windows.
      Use "cygwin" (default) for opam's internal Cygwin, or "msys2" to use
      the pre-installed MSYS2 on GitHub-hosted runners.
    required: false
    default: cygwin
  allow-prerelease-opam:
    description: >-
      Allow the use of a pre-release version of opam. Set to "true" to opt
      in to pre-release builds when available. Has no effect when no
      pre-release version is available.
    required: false
    default: "false"
  github-token:
    description: >-
      GitHub token used internally to query opam-repository for available
      compiler versions. The default token is sufficient for most use
      cases. DO NOT SET THIS unless you need to use a custom token.
    required: false
    default: ${{ github.token }}
runs:
  using: node24
  main: dist/index.mjs
  post: dist/post/index.mjs
  post-if: success()