ReleaseKit.BuildInfo (ReleaseKit v0.3.0)

Copy Markdown

Records build-tool and source-control metadata for an artifact.

Summary

Types

t()

Functions

detect()

Detects build metadata for the current project checkout.

to_external_map(build)

Converts build metadata to the external manifest representation.

Types

t()

@type t() :: %ReleaseKit.BuildInfo{
  elixir_version: String.t(),
  git_dirty?: boolean() | nil,
  git_revision: String.t() | nil,
  otp_version: String.t(),
  release_kit_version: String.t()
}

Functions

detect()

@spec detect() :: t()

Detects build metadata for the current project checkout.

to_external_map(build)

@spec to_external_map(t()) :: map()

Converts build metadata to the external manifest representation.