package dockerfile-cmd

  1. Overview
  2. Docs
Dockerfile eDSL -- generation support

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (8)

Authors

  1. A
    Anil Madhavapeddy
  2. A
    Anton Kochkov
  3. A
    Antonin Décimo
  4. David Allsopp
  5. E
    Ewan Mellor
  6. K
    Kate Deplaix
  7. L
    Louis Gesbert
  8. M
    Mark Elvers
  9. T
    Thomas Leonard
  10. T
    Tim McGilchrist

Maintainers

  1. A
    Anil Madhavapeddy <anil@recoil.org>
  2. A
    Antonin Décimo <antonin@tarides.com>
  3. David Allsopp
  4. K
    Kate <kit.ty.kate@disroot.org>
  5. T
    Thomas Leonard <talex5@gmail.com>
  6. T
    Tim McGilchrist <timmcgil@gmail.com>

Sources

ocaml-dockerfile-8.3.3.tbz
md5=7d5314dedfd0a897e8e908a7173001f7
sha512=163c9e1c061026fbf7776962f551662304c4ee146a777e3d996d0222417a590f48c01cb86d3dd2989e77d66d73c0a587d429097ca744b1063a2057b39233f16c

doc/dockerfile-cmd/Dockerfile_cmd/index.html

Module Dockerfile_cmdSource

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.

Sourcetype cmd_log = {
  1. command : string;
  2. stdout : string;
  3. success : bool;
  4. status : [ `Signaled of int | `Exited of int ];
}

Results of a command invocation

Sourceval sexp_of_cmd_log : cmd_log -> Sexplib0.Sexp.t
Sourceval cmd_log_of_sexp : Sexplib0.Sexp.t -> cmd_log
Sourceval run_log : ?ok_to_fail:bool -> ?env:Bos.OS.Env.t -> Fpath.t -> string -> Bos.Cmd.t -> (unit, [> `Msg of string ]) result

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

Sourcemodule Docker : sig ... end

Docker command invocation

Sourcemodule Opam : sig ... end

Opam2 command invocation

Utility functions

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

setup_logs () initialises a Logs environment.

Sourceval iter : ('a -> (unit, 'b) result) -> 'a list -> (unit, 'b) result
Sourceval map : ('a -> ('b, 'c) result) -> 'a list -> ('b list, 'c) result

Generate Dockerfiles

Sourcemodule Gen : sig ... end

Utility functions to generate Dockerfiles.