apply

Documentation

Index

• Variables
• type ConflictResolution
• type ConflictResolutionAction
• type Options
• type Policy
• type Result
  • func Apply(opts Options) (*Result, error)

Variables

var (
	ErrInteractiveRequired = errors.New("interactive input required")
	ErrConflictRefused     = errors.New("conflict policy refused to apply incoming data")
	ErrMergeBaseMissing    = errors.New("three-way merge requires a base revision")
	ErrUnknownAncestry     = errors.New("three-way merge base revision is unknown locally")
	ErrMergeConflict       = errors.New("three-way merge produced unresolved conflicts")
)

Types

type ConflictResolution

type ConflictResolution struct {
	Key    string
	Action ConflictResolutionAction
	Value  string
}

type ConflictResolutionAction

type ConflictResolutionAction string

const (
	ConflictUseLocal   ConflictResolutionAction = "use-local"
	ConflictUseRemote  ConflictResolutionAction = "use-remote"
	ConflictUseCustom  ConflictResolutionAction = "use-custom"
	ConflictKeepAbsent ConflictResolutionAction = "keep-absent"
)

type Options

type Options struct {
	ProjectID           string
	TargetFile          string
	IncomingFile        string
	IncomingData        []byte
	BaseRevisionID      string
	AncestorRevisionIDs []string
	NewRevisionID       string
	Policy              Policy
	Interactive         bool
	BackupEnabled       bool
	BackupKey           [32]byte
	MaxVersions         int
	OnDiff              func(diff *envfile.DiffResult)
	ConfirmApply        func(diff *envfile.DiffResult) bool
	ResolveConflicts    func(conflicts []envfile.Conflict) ([]ConflictResolution, bool)
}

type Policy

type Policy string

const (
	PolicyInteractive Policy = "interactive"
	PolicyOverwrite   Policy = "overwrite"
	PolicyKeepLocal   Policy = "keep-local"
	PolicyThreeWay    Policy = "three-way"
	PolicyFail        Policy = "fail"
)

type Result

type Result struct {
	Applied                  bool
	Changed                  bool
	BackupCreated            bool
	InteractiveRequired      bool
	ManualInterventionNeeded bool
	ConflictPolicyApplied    string
	Diff                     *envfile.DiffResult
	Summary                  string
	VariableCount            int
	FinalRevisionID          string
}

func Apply

func Apply(opts Options) (*Result, error)