Nerves v1.5.1 Nerves.Artifact.BuildRunner behaviour View Source

Defines the Nerves build runner behaviour

A build runner is a module that can take package source and produce artifacts.

Link to this section Summary

archive_result() :: {:ok, path :: String.t()} | {:error, reason :: term()}

build_result() :: {:ok, build_path :: String.t()} | {:error, reason :: term()}

clean_result() :: :ok | {:error, reason :: term()}

archive(package :: Nerves.Package.t(), toolchain :: atom(), opts :: term()) ::
  archive_result()

build(package :: Nerves.Package.t(), toolchain :: atom(), opts :: term()) ::
  build_result()

clean(package :: Nerves.Package.t()) :: clean_result()