Akd v0.2.0-rc.0 Akd View Source

A framework that makes elixir deployments a breeze. It’s highly configurable, yet easy to set up.

Link to this section Summary

Functions

:build can be set as a runtime config in the config.exs file

Gets configuration assocaited with the akd app

Gets configuration set for a key, assocaited with the akd app

:fetch can be set as a runtime config in the config.exs file

:init can be set as a runtime config in the config.exs file

:publish can be set as a runtime config in the config.exs file

resolve_config returns a system variable set up with var_name key or returns the specified default value. Takes in arg whose first element is an atom :system

:start can be set as a runtime config in the config.exs file

:stop can be set as a runtime config in the config.exs file

Link to this section Functions

:build can be set as a runtime config in the config.exs file

Examples

when no build config is set, if returns Akd.Build.Distillery

iex> Akd.build
Akd.Build.Distillery

Gets configuration assocaited with the akd app.

Examples

when no config is set, if returns []

iex> Akd.config
[]
Link to this function config(key, default \\ nil) View Source

Gets configuration set for a key, assocaited with the akd app.

Examples

when no config is set for key, if returns default

iex> Akd.config(:random, "default")
"default"

:fetch can be set as a runtime config in the config.exs file

Examples

when no fetch config is set, if returns Akd.Fetch.Git

iex> Akd.fetch
Akd.Fetch.Git

:init can be set as a runtime config in the config.exs file

Examples

when no init config is set, if returns Akd.Init.Distillery

iex> Akd.init
Akd.Init.Distillery

:publish can be set as a runtime config in the config.exs file

Examples

when no publish config is set, if returns Akd.Publish.Distillery

iex> Akd.publish
Akd.Publish.Distillery
Link to this function resolve_config(value, default) View Source
resolve_config(Tuple.t(), term()) :: {term()}

resolve_config returns a system variable set up with var_name key or returns the specified default value. Takes in arg whose first element is an atom :system.

Examples

Returns value corresponding to a system variable config or returns the default value:

iex> Akd.resolve_config({:system, "SOME_RANDOM_CONFIG"}, "default")
"default"

:start can be set as a runtime config in the config.exs file

Examples

when no start config is set, if returns Akd.Start.Distillery

iex> Akd.start
Akd.Start.Distillery

:stop can be set as a runtime config in the config.exs file

Examples

when no stop config is set, if returns Akd.Stop.Distillery

iex> Akd.stop
Akd.Stop.Distillery