Mate.Session (Mate v0.1.5) View Source

This module contains all relevant information to the current session when running the mate.deploy mix task.

It keeps track of the current configuration, build pipeline, assigns that can be used to transfer information between build steps, the current context to determine wheter this is a building session or a deploying session, and more!

Link to this section Summary

Functions

Creates a new Mate.Session struct based on the given config file and optionally any other options can be set.

Link to this section Types

Specs

t() :: %Mate.Session{
  assigns: map(),
  config: Mate.Config.t(),
  conn: any(),
  context: :build | :deploy,
  driver: atom(),
  finished_at: DateTime.t() | nil,
  pipeline: Mate.Pipeline.t(),
  remote: Mate.Remote.t(),
  started_at: DateTime.t() | nil,
  verbosity: integer()
}

Link to this section Functions

Specs

new(config :: Mate.Config.t(), keyword()) :: t()

Creates a new Mate.Session struct based on the given config file and optionally any other options can be set.