package dockerfile-cmd

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Utility functions

dockerfile-cmd
- Dockerfile_cmd
  - Docker
  - Opam
- Dockerfile_gen

Legend:
Library
Module
Module type
Parameter
Class
Class type

Command invocation library to help with Docker builds.

This module primarily exposes utility functions to glue together Docker-based scripts for (e.g.) continuous integration systems like the ocaml-ci. The interface is fairly domain-specific and does not expose all the functionality of the underlying tools. Feel free to contribute more functions if you need them.

type cmd_log = {

command : string;
stdout : string;
success : bool;
status : [ `Signaled of int | `Exited of int ];

}

Results of a command invocation

val sexp_of_cmd_log : cmd_log -> Ppx_sexp_conv_lib.Sexp.t

val cmd_log_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> cmd_log

val run_log : 
  ?ok_to_fail:bool ->
  ?env:Bos.OS.Env.t ->
  Fpath.t ->
  string ->
  Bos.Cmd.t ->
  (unit, [> Rresult.R.msg ]) result

runlog log_dir name cmd will run cmd with label name and log the results in <log_dir>/<name>.sxp.

module Docker : sig ... end

Docker command invocation

module Opam : sig ... end

Opam2 command invocation

Utility functions

val setup_logs : unit -> unit Cmdliner.Term.t

setup_logs () initialises a Logs environment.

val iter : ('a -> (unit, 'b) result) -> 'a list -> (unit, 'b) result

val map : ('a -> ('b, 'c) result) -> 'a list -> ('b list, 'c) result