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

Copy Markdown View Source

Desired source checkout. Git is the first supported backend.

Summary

Types

dirty_policy()
ref_kind()
t()
type()

Functions

app_path(source)
id(source)
identity(source)
new(name, opts)

Types

dirty_policy()

@type dirty_policy() :: :error | :reset | :ignore

ref_kind()

@type ref_kind() :: :branch | :tag | :revision | :unknown

t()

@type t() :: %HostKit.Resources.Source{
  checkout: String.t(),
  depends_on: [term()],
  dirty: dirty_policy(),
  meta: map(),
  name: atom() | String.t(),
  path: String.t(),
  ref: String.t(),
  ref_kind: ref_kind(),
  revision: String.t() | nil,
  type: type(),
  uri: String.t()
}

type()

@type type() :: :git

Functions

app_path(source)

id(source)

identity(source)

new(name, opts)

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