Akd v0.2.1 Akd.Start.Distillery View Source
A native Hook module that comes shipped with Akd.
This module uses Akd.Hook
.
Provides a set of operations that can start an app built and released using distillery.
If fails, it stops the started node.
Options:
run_ensure
:boolean
. Specifies whether to a run a command or not.ignore_failure
:boolean
. Specifies whether to continue if this hook fails.
Defaults:
run_ensure
:true
ignore_failure
:false
Link to this section Summary
Functions
Callback implementation for get_hooks/2
Link to this section Functions
Link to this function
get_hooks(deployment, opts)
View Source
get_hooks(Akd.Deployment.t(), Keyword.t()) :: [Akd.Hook.t()]
get_hooks(Akd.Deployment.t(), list()) :: Akd.Hook.t()
Callback implementation for get_hooks/2
.
This function returns a list of operations that can be used to start an app
built by distillery on the publish_to
destination of a deployment.
Examples
iex> deployment = %Akd.Deployment{mix_env: "prod",
...> build_at: Akd.Destination.local("."),
...> publish_to: Akd.Destination.local("."),
...> name: "name",
...> vsn: "0.1.1"}
iex> Akd.Start.Distillery.get_hooks(deployment, [])
[%Akd.Hook{ensure: [], ignore_failure: false,
main: [%Akd.Operation{cmd: "bin/name start", cmd_envs: [],
destination: %Akd.Destination{host: :local, path: ".",
user: :current}}],
rollback: [%Akd.Operation{cmd: "bin/name stop", cmd_envs: [],
destination: %Akd.Destination{host: :local, path: ".",
user: :current}}], run_ensure: true}]