distillery

v2.1.1

distillery v2.1.1 Distillery.Releases.Release View Source

Represents metadata about a release

Link to this section Summary

Types

app_resource()
resource()
t()

Functions

apps(release)

Gets a list of {app, vsn} tuples for the current release.

archive_path(r)

Get the path to which the release tarball will be output

bin_path(release)

Get the path to which release binaries will be output

executable?(release)

Returns true if the release is executable

get(name, env \\ :default, opts \\ [])

Load a fully configured Release object given a release name and environment name.

get_code_paths(release)

Returns a list of all code_paths of all applications included in the release

lib_path(release)

Get the path to which compiled applications will be output

new(name, version, apps \\ [])

Creates a new Release with the given name, version, and applications.

to_resource(release)

Converts a Release struct to a release resource structure.

version_path(r)

Get the path to which versioned release data will be output

Link to this section Types

Link to this type

app_resource() View Source 
app_resource() ::
  {atom(), app_version :: charlist()}
  | {atom(), app_version :: charlist(), Distillery.Releases.App.start_type()}

Link to this type

resource() View Source 
resource() ::
  {:release, {name :: charlist(), version :: charlist()},
   {:erts, erts_version :: charlist()}, [app_resource()]}

Link to this type

t() View Source 
t() :: %Distillery.Releases.Release{
  applications: [
    atom()
    | {atom(), Distillery.Releases.App.start_type()}
    | Distillery.Releases.App.t()
  ],
  env: atom(),
  is_upgrade: boolean(),
  name: atom(),
  profile: Distillery.Releases.Profile.t(),
  resolved_overlays: [Distillery.Releases.Overlays.overlay()],
  upgrade_from: nil | String.t() | :latest,
  version: String.t()
}

Link to this section Functions

Link to this function

apps(release) View Source 
apps(t()) :: [Distillery.Releases.App.t()] | {:error, term()}

Gets a list of {app, vsn} tuples for the current release.

An optional second parameter enables/disables debug logging of discovered apps.

Link to this function

archive_path(r) View Source 
archive_path(t()) :: String.t()

Get the path to which the release tarball will be output

Link to this function

bin_path(release) View Source 
bin_path(t()) :: String.t()

Get the path to which release binaries will be output

Link to this function

executable?(release) View Source 
executable?(t()) :: boolean()

Returns true if the release is executable

Link to this function

get(name, env \\ :default, opts \\ []) View Source 
get(atom(), atom(), Keyword.t()) :: {:ok, t()} | {:error, term()}

Load a fully configured Release object given a release name and environment name.

Link to this function

get_code_paths(release) View Source 
get_code_paths(t()) :: [charlist()]

Returns a list of all code_paths of all applications included in the release

Link to this function

lib_path(release) View Source 
lib_path(t()) :: String.t()

Get the path to which compiled applications will be output

Link to this function

new(name, version, apps \\ []) View Source 
new(atom(), String.t(), [atom()]) :: t()

Creates a new Release with the given name, version, and applications.

Link to this function

to_resource(release) View Source 
to_resource(t()) :: resource()

Converts a Release struct to a release resource structure.

The format of release resources is documented in the Erlang manual

Link to this function

version_path(r) View Source 
version_path(t()) :: String.t()

Get the path to which versioned release data will be output