HostKit.Resources.Command (host_kit v0.1.0-beta.1)

Copy Markdown View Source

Declarative command step used for build/bootstrap workflows.

Summary

Types

exec()

@type exec() :: {String.t(), [String.t()]}

runtime()

@type runtime() :: nil | {:mise, atom()}

t()

@type t() :: %HostKit.Resources.Command{
  creates: String.t() | nil,
  cwd: String.t() | nil,
  depends_on: [term()],
  down: t() | :noop | :irreversible | nil,
  env: %{required(String.t()) => String.t()},
  exec: exec(),
  inputs: [String.t() | HostKit.Source.Ref.t()],
  meta: map(),
  name: atom() | String.t(),
  outputs: [String.t()],
  phase: atom() | nil,
  runtime: runtime(),
  stamp: String.t() | nil,
  timeout: non_neg_integer() | nil,
  unless: String.t() | nil
}

Functions

id(command)

new(name, opts)

@spec new(
  atom() | String.t(),
  keyword()
) :: t()