Pipette.Info (Pipette v0.5.1)

Copy Markdown View Source

Accessor functions for reading pipeline configuration from Spark DSL modules.

These functions extract entities and options from modules that use Pipette.DSL:

branches  = Pipette.Info.branches(MyApp.Pipeline)
groups    = Pipette.Info.groups(MyApp.Pipeline)
pipeline  = Pipette.Info.to_pipeline(MyApp.Pipeline)

Summary

Functions

Returns all %Pipette.Branch{} entities.

Returns the pipeline-level :cache config.

Returns the pipeline-level :env map.

Returns the pipeline-level :force_activate map.

Returns all %Pipette.Group{} entities.

Returns the pipeline-level :ignore patterns.

Returns all %Pipette.Scope{} entities.

Returns the pipeline-level :secrets list.

Assembles a %Pipette.Pipeline{} struct from the Spark DSL data on the given module.

Returns all %Pipette.Trigger{} entities.

Functions

branches(module)

@spec branches(module()) :: [Pipette.Branch.t()]

Returns all %Pipette.Branch{} entities.

cache(module)

@spec cache(module()) :: keyword() | nil

Returns the pipeline-level :cache config.

env(module)

@spec env(module()) :: map()

Returns the pipeline-level :env map.

force_activate(module)

@spec force_activate(module()) :: map()

Returns the pipeline-level :force_activate map.

groups(module)

@spec groups(module()) :: [Pipette.Group.t()]

Returns all %Pipette.Group{} entities.

ignore(module)

@spec ignore(module()) :: [String.t()]

Returns the pipeline-level :ignore patterns.

scopes(module)

@spec scopes(module()) :: [Pipette.Scope.t()]

Returns all %Pipette.Scope{} entities.

secrets(module)

@spec secrets(module()) :: [String.t()]

Returns the pipeline-level :secrets list.

to_pipeline(module)

@spec to_pipeline(module()) :: Pipette.Pipeline.t()

Assembles a %Pipette.Pipeline{} struct from the Spark DSL data on the given module.

triggers(module)

@spec triggers(module()) :: [Pipette.Trigger.t()]

Returns all %Pipette.Trigger{} entities.