distillery v2.0.8 Mix.Releases.Checks behaviour View Source

This module defines a behavior for, and orchestrator of, static analysis checks to be performed at release-time. These checks are intended to operate on the fully reified release configuration and metadata, and return warnings, errors, or ok for the release assembler to react to.

In most cases, warnings will be printed but assembly will continue; errors will be printed but will terminate assembly, and a successful check will be printed only if verbose logging is enabled.

Link to this section Summary

Types

warning()

Functions

list()

Returns a list of all checks available to be applied

run(release)

Runs all default and configured checks against the given release

run(checks, release)

Runs all of the given checks, in the given order

Callbacks

run(arg0)

Link to this section Types

warning()

warning() :: String.t()

Link to this section Functions

list()

Returns a list of all checks available to be applied.

run(release)

run(Mix.Releases.Release.t()) :: :ok | {:ok, warning()} | {:error, term()}

Runs all default and configured checks against the given release.

run(checks, release)

run([module()], Mix.Releases.Release.t()) ::
  :ok | {:ok, warning()} | {:error, term()}

Runs all of the given checks, in the given order.

Link to this section Callbacks

run(arg0)

run(Mix.Releases.Release.t()) ::
  :ok | {:ok, warning :: String.t()} | {:error, term()}