integrations

Documentation

Overview

Package integrations handles `ginger add <integration>` by generating platform integration files and updating go.mod dependencies.

Index

• Variables
• func Add(name string) error
• func NeedsPostApply(name string, p *plan.Plan) bool
• func Plan(name string, prj *project.Project, overwrite bool) (*plan.Plan, error)
• func PostApply(name, projectRoot string) error

Variables

var ErrIntegrationExists = errors.New("integration already exists")

ErrIntegrationExists is returned when the target integration file already exists.

Functions

func Add

func Add(name string) error

Add generates the integration file and runs go get for the required package.

func NeedsPostApply

func NeedsPostApply(name string, p *plan.Plan) bool

NeedsPostApply reports whether the plan created or replaced the integration implementation and therefore needs dependency installation.

func Plan

func Plan(name string, prj *project.Project, overwrite bool) (*plan.Plan, error)

Plan builds a root-aware plan for adding an integration. Existing user files are modified only when owned by the manifest or through a managed region.

func PostApply

func PostApply(name, projectRoot string) error

PostApply installs a declared Go dependency. File changes, including compose changes, are always handled by the plan itself.