GitHubActions.Config (GitHubActions v0.3.15)

View Source

A simple keyword-based configuration API.

Examples

This module is used to define the configuration for GitHubActions.

import GitHubActions.Config

config :linux,
  name: "Ubuntu",
  runs_on: "ubuntu-24.04"

config key: "value"

Summary

Types

config()
key()
keys()
value()

Functions

config()

Returns the configuration.

config(data)

Adds the given data to the configuration.

config(key, value)

Adds the given value to the configuration under the given key.

fetch(keys)

Returns the value for key or keys in a tuple.

fetch!(keys)

Returns the value for key or keys.

get(keys, default \\ nil)

Returns the value for key or keys.

read(path)

Reads the configuration from the given path.

Types

config()

@type config() :: keyword()

key()

@type key() :: atom()

keys()

@type keys() :: [atom()]

value()

@type value() :: any()

Functions

config()

@spec config() :: config()

Returns the configuration.

config(data)

@spec config(config()) :: config() | nil

Adds the given data to the configuration.

Returns the configuration that was previously stored.

config(key, value)

@spec config(key(), value()) :: config() | nil

Adds the given value to the configuration under the given key.

Returns the configuration that was previously stored.

fetch(keys)

@spec fetch(key() | keys()) :: value()

Returns the value for key or keys in a tuple.

If the configuration parameter does not exist, the function returns error.

Examples

iex> Config.fetch(:jobs)
{:ok, [:linux]}

iex> Config.fetch(:foo)
:error

iex> Config.fetch([:linux, :name])
{:ok, "Ubuntu"}

fetch!(keys)

@spec fetch!(key() | keys()) :: value()

Returns the value for key or keys.

Examples

iex> Config.fetch!(:jobs)
[:linux]

iex> Config.fetch!([:linux, :runs_on])
"ubuntu-24.04"

get(keys, default \\ nil)

@spec get(key() | keys(), value()) :: value()

Returns the value for key or keys.

If the configuration parameter does not exist, the function returns the default value.

Examples

iex> Config.get(:jobs)
[:linux]

iex> Config.get(:foo, :bar)
:bar

iex> Config.get([:linux, :runs_on])
"ubuntu-24.04"

iex> Config.get(:foo)
nil

read(path)

@spec read(Path.t()) :: :ok | {:error, :enonet}

Reads the configuration from the given path.