distillery v2.0.0-rc.6 Mix.Releases.Release

Represents metadata about a release

Link to this section Summary

Functions

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

Get the path to which the release tarball will be output

Get the path to which release binaries will be output

Returns true if the release is executable

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

Get the path to which compiled applications will be output

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

Converts a Release struct to a release resource structure

Get the path to which versioned release data will be output

Link to this section Types

Link to this type app_resource()
app_resource() ::
  {atom(), app_version :: charlist()}
  | {atom(), app_version :: charlist(), Mix.Releases.App.start_type()}
Link to this type resource()
resource() ::
  {:release, {name :: charlist(), version :: charlist()},
   {:erts, erts_version :: charlist()}, [app_resource()]}
Link to this type t()
t() :: %Mix.Releases.Release{
  applications: [
    atom() | {atom(), Mix.Releases.App.start_type()} | Mix.Releases.App.t()
  ],
  env: atom(),
  is_upgrade: boolean(),
  name: atom(),
  output_dir: String.t(),
  profile: Mix.Releases.Profile.t(),
  resolved_overlays: [Mix.Releases.Overlays.overlay()],
  upgrade_from: nil | String.t() | :latest,
  version: String.t()
}

Link to this section Functions

Link to this function apps(release)
apps(t()) :: [{atom(), String.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)
archive_path(t()) :: String.t()

Get the path to which the release tarball will be output

Link to this function bin_path(release)
bin_path(t()) :: String.t()

Get the path to which release binaries will be output

Link to this function executable?(release)
executable?(t()) :: boolean()

Returns true if the release is executable

Link to this function get(name, env \\ :default, opts \\ [])
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)
get_code_paths(t()) :: [charlist()]

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

Link to this function lib_path(release)
lib_path(t()) :: String.t()

Get the path to which compiled applications will be output

Link to this function new(name, version, apps \\ [])
new(atom(), String.t(), [atom()]) :: t()

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

Link to this function to_resource(release)
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)
version_path(t()) :: String.t()

Get the path to which versioned release data will be output