Akd v0.3.0 Akd.Build.Release View Source

A native Hook module that comes shipped with Akd.

This module uses Akd.Hook.

Provides a set of operations that build a distillery release for a given app at a deployment's build_at destination. This hook assumes that a distillery rel config file, rel/config.exs is already present or initialized by either a previously executed hook or manually.

Ensures to cleanup and empty the releases created by this build.

Doesn't have any Rollback operations.

Options:

run_ensure: boolean. Specifies whether to a run the ensure commands of a hook or not. This is useful when specifying whether or not to clean up after and operation. Defaults to true.
ignore_failure: boolean. Specifies whether to continue if this hook fails. This is useful when a hook's failure is to be ignored, and a deployed can be continued without halting the pipeline.
cmd_envs: list of tuples. Specifies the environments to provide while building the distillery release.

Defaults:

run_ensure: true
ignore_failure: false
cmd_envs: [false]

Link to this section Summary

Functions

get_hooks(deployment, opts)

Callback implementation for get_hooks/2

Link to this section Functions

get_hooks(deployment, opts)

get_hooks(Akd.Deployment.t(), list()) :: Akd.Hook.t()

get_hooks(Akd.Deployment.t(), Keyword.t()) :: [Akd.Hook.t()]

Callback implementation for get_hooks/2.

This function returns a list of operations that can be used to build a release using distillery on the build_at 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.Build.Release.get_hooks(deployment, [])
[%Akd.Hook{ensure: [], ignore_failure: false,
    main: [%Akd.Operation{cmd: "rm -rf ./_build/prod/rel",
      cmd_envs: [],
      destination: %Akd.Destination{host: :local, path: ".",
      user: :current}},
      %Akd.Operation{cmd: "mix deps.get \n mix compile \n mix release",
      cmd_envs: [{"MIX_ENV", "prod"}],
      destination: %Akd.Destination{host: :local, path: ".",
       user: :current}}], rollback: [], run_ensure: true}]

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.Build.Release.get_hooks(deployment, [release_name: "name"])
[%Akd.Hook{ensure: [], ignore_failure: false,
   main: [%Akd.Operation{cmd: "rm -rf ./_build/prod/rel",
     cmd_envs: [],
     destination: %Akd.Destination{host: :local, path: ".",
     user: :current}},
     %Akd.Operation{cmd: "mix deps.get \n mix compile \n mix release name",
     cmd_envs: [{"MIX_ENV", "prod"}],
     destination: %Akd.Destination{host: :local, path: ".",
      user: :current}}], rollback: [], run_ensure: true}]

iex> deployment = %Akd.Deployment{mix_env: "prod",
...> build_at: Akd.Destination.local("."),
...> publish_to: Akd.Destination.local("."),
...> name: "name",
...> vsn: "0.1.1",
...> data: %{release_name: "name"}}
iex> Akd.Build.Release.get_hooks(deployment, [])
[%Akd.Hook{ensure: [], ignore_failure: false,
   main: [%Akd.Operation{cmd: "rm -rf ./_build/prod/rel",
     cmd_envs: [],
     destination: %Akd.Destination{host: :local, path: ".",
     user: :current}},
     %Akd.Operation{cmd: "mix deps.get \n mix compile \n mix release name",
     cmd_envs: [{"MIX_ENV", "prod"}],
     destination: %Akd.Destination{host: :local, path: ".",
      user: :current}}], rollback: [], run_ensure: true}]

Akd

v0.3.0