ocaml / setup-ocaml

Set up OCaml **STATUS: STABLE** Set up an OCaml and opam environment in GitHub Actions and add to PATH. Usage Example workflow Consult the Hello World OCaml Action that uses Dune and opam to build a simple library. It's possible to feed different values to the input depending on the platform of the runner. The syntax of GitHub's workflows is flexible enough to offer several methods to do this. OCaml Compiler Support Matrix When using GitHub-hosted runners, specifying compiler version or should work across all platforms and architectures. However, there are exceptions, as shown below. If you need to test with specific versions, please choose the appropriate version for your runtime environment. x86 64 bits | Version | Ubuntu | macOS | Windows (MinGW-w64) | Windows (MSVC) | | ----------------- | ------------------ | ------------------ | ------------------- | ------------------ | | >= 5.3 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | >= 5.0 & = 4.13 & = 4.02 & = 4.12 | :white_check_mark: | :white_check_mark: | :x: | | = 4.11 | :white_check_mark: | :x: | :x: | | = 4.10 | :white_check_mark: | :white_check_mark: | :x: | | >= 4.02 & [!NOTE] > Binding to a major version is the latest of that major version (e.g. = ) Major versions should guarantee compatibility. A major version can add net new capabilities but should not break existing input compatibility or break existing workflows. > [!WARNING] > Do not reference since that is the latest code and can be carrying breaking changes of the next major version. Major version binding allows you to take advantage of bug fixes, critical functionality and security fixes. The branch has the latest code and is unstable to bind to since changes get committed to the and released by creating a tag. Inputs | Name | Required | Description | Type | Default | | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ----------------------------------------------------------- | | | Yes | The OCaml compiler packages to initialise. Consult the supported version syntax section. | string | | | | No | A YAML mapping of opam repository name/URL pairs to use. Repositories listed first take priority over later ones. | string | | | | No | Automatically pin local opam packages (matched by ) in the opam switch. Set to to skip pinning. | bool | | | | No | A glob pattern matching the local files to be pinned when is enabled. Consult the documentation for supported patterns. | string | | | | No | Disable the opam sandboxing feature. opam uses Bubblewrap on Linux and sandbox-exec on macOS. Useful for self-hosted runners where the sandbox tool is not available. On Windows, sandboxing is always disabled. | bool | | | | No | 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. | bool | | | | No | The prefix used for all cache keys. Change this value to force a cache invalidation when the cache becomes corrupted or stale. | string | | | | No | The C compiler toolchain used for building on Windows. Use (default) for mingw-w64 (GCC), or for the Microsoft Visual C compiler. MSVC requires Visual Studio (pre-installed on GitHub-hosted runners). | string | | | | No | The Unix environment used for building on Windows. Use (default) for opam's internal Cygwin, or to use the pre-installed MSYS2 on GitHub-hosted runners. | string | | | | No | Allow the use of a pre-release version of opam. Has no effect when no pre-release version is available. | bool | | Supported version syntax The input supports the Semantic Versioning Specification, for more detailed examples please refer to the documentation. When a version range is used (e.g., , ), the highest matching version from the opam-repository is always selected. > [!WARNING] > Version numbers containing a dot **must be quoted** in YAML to avoid being parsed as floats. For example, an unquoted is parsed as the float , which would silently resolve to the latest compiler instead of . To be safe, always quote version values: > > > [!NOTE] > With the naughty exception of , point releases are meant to be strictly compatible, so once we (OCaml dev team) release a new point release, upgrading should be a no-brainer. Examples: • Exact package name: • Combine multiple packages: • Major versions: , • Minor versions: , , , • More specific versions: , Advanced Configurations Consult the examples page for more complex patterns. Extensions **STATUS: STABLE** > [!NOTE] > All extensions are recommended to be used in separate jobs run on . • analysis • lint-doc • lint-fmt • lint-opam Automatically updating the actions with Dependabot Consult the Configuring Dependabot version updates page and set as described below to allow Dependabot to update the actions automatically. > [!NOTE] > Renovate is also available for free as a third-party tool, which is much more flexible than Dependabot - depending on the project and your preferences. If you just want to automate GitHub Actions updates, Dependabot is good enough. Roadmap This action aims to provide an OS-neutral interface to , and so will not add features that only work on one operating system. It will also track the latest stable release of opam. Support Please feel free to post to the discuss.ocaml.org forum with any questions you have about this action. Previous discussions include: • •