Generated reference for the harmont Ocaml API.
ocaml
Callable singleton for the OCaml toolchain — access as hm.ocaml.
Call directly to construct an OCamlProject, or use the bare-form
action methods (ocaml.build(), ocaml.test(), etc.) for a
one-shot leaf.
ocaml(*, path='.', compiler='5.1.1', image=None, base=None) -> OCamlProject| Parameter | Type | Default | Description |
|---|---|---|---|
path | str | '.' | Path to the OCaml project root. If *.opam files are |
present, opam install . --deps-only is run and cached on | |||
| those files. | |||
compiler | str | '5.1.1' | OCaml compiler version to install via opam |
(e.g. "5.1.1"). | |||
image | str | None | None | Local-mode Docker base image override. |
base | Step | None | None | Existing Step to attach to instead of emitting a fresh |
| apt-base step. |
Returns OCamlProject — An OCamlProject whose installed step is the opam-deps step.
ocaml.build()
build(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
ocaml.fmt()
fmt(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
ocaml.test()
test(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
OCamlEntry
Callable singleton for the OCaml toolchain — access as hm.ocaml.
Call directly to construct an OCamlProject, or use the bare-form
action methods (ocaml.build(), ocaml.test(), etc.) for a
one-shot leaf.
OCamlEntry.build()
build(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
OCamlEntry.fmt()
fmt(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
OCamlEntry.test()
test(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
OCamlProject
OCaml project install chain — constructed via hm.ocaml().
installed is the opam-deps step. Action methods (build,
test, fmt) attach leaves to installed.
Fields
| Field | Type | Default |
|---|---|---|
path | str | required |
installed | Step | required |
OCamlProject.build()
build(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
OCamlProject.fmt()
fmt(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step
OCamlProject.test()
test(**kw) -> Step| Parameter | Type | Default | Description |
|---|---|---|---|
kw | Any | {} | — |
Returns Step