View Source Jellyfish.Releases.Appups (Jellyfish v0.2.2)

Generate appup files for hot upgrades

Copied and/or modified from https://github.com/bitwalker/distillery/blob/master/lib/distillery/releases/appups.ex

Summary

Types

app()

appup()

appup_ver()

change()

dep_mods()

downgrade_instructions()

instruction()

path_str()

upgrade_instructions()

version_str()

Functions

locate(app, v1, v2)

Given an application name, and two versions, look for a custom appup which applies.

make(application, v1, v2, v1_path, v2_path, transforms \\ [])

Generate a .appup for the given application, start version, and upgrade version.

Types

app()

@type app() :: atom()

appup()

@type appup() :: {appup_ver(), upgrade_instructions(), downgrade_instructions()}

appup_ver()

@type appup_ver() :: charlist() | binary()

change()

@type change() :: :soft | {:advanced, [term()]}

dep_mods()

@type dep_mods() :: [module()]

downgrade_instructions()

@type downgrade_instructions() :: [{appup_ver(), instruction()}]

instruction()

@type instruction() ::
  {:add_module, module()}
  | {:delete_module, module()}
  | {:update, module(), :supervisor | change()}
  | {:update, module(), change(), dep_mods()}
  | {:load_module, module()}
  | {:load_module, module(), dep_mods()}
  | {:apply, {module(), atom(), [term()]}}
  | {:add_application, atom()}
  | {:remove_application, atom()}
  | {:restart_application, atom()}
  | :restart_new_emulator
  | :restart_emulator

path_str()

@type path_str() :: String.t()

upgrade_instructions()

@type upgrade_instructions() :: [{appup_ver(), instruction()}]

version_str()

@type version_str() :: String.t()

Functions

locate(app, v1, v2)

@spec locate(app(), version_str(), version_str()) :: nil | String.t()

Given an application name, and two versions, look for a custom appup which applies.

make(application, v1, v2, v1_path, v2_path, transforms \\ [])

@spec make(app(), version_str(), version_str(), path_str(), path_str(), [module()]) ::
  {:ok, appup()} | {:error, term()}

Generate a .appup for the given application, start version, and upgrade version.

Parameters

- application: the application name as an atom
- v1: the previous version, such as "0.0.1"
- v2: the new version, such as "0.0.2"
- v1_path: the path to the v1 artifacts (rel/<app>/lib/<app>-0.0.1)
- v2_path: the path to the v2 artifacts (_build/prod/lib/<app>)