distillery v1.2.0 Mix.Releases.Release

Represents metadata about a release

Summary

Functions

Get the path at which the release tarball will be output

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

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

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

Types

t()
t() :: %Mix.Releases.Release{applications: [atom | {atom, Mix.Releases.App.start_type} | Mix.Releases.App.t], is_upgrade: boolean, name: atom, output_dir: term, profile: Mix.Releases.Profile.t, resolved_overlays: [Mix.Releases.Overlays.overlay], upgrade_from: nil | String.t, version: String.t}

Functions

archive_path(r)
archive_path(Mix.Releases.Release.t) :: String.t

Get the path at which the release tarball will be output

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

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

get_code_paths(release)
get_code_paths(Mix.Releases.Release.t) :: [charlist]

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

new(name, version, apps \\ [])
new(atom, String.t, [atom]) :: Mix.Releases.Release.t

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