selector

Documentation

Index

• Constants
• type Option
• type Options
• type Selection
• type Selector
  • func NewSelector(options ...Option) *Selector
  • func (s *Selector) AddFlags(cobraCommand *cobra.Command)
  • func (s *Selector) GetSelection(state terra.State, pflags *pflag.FlagSet, args []string) (*Selection, error)

Constants

const ReleasesFlagName = "release"

ReleasesFlagName constant used for the --release flag name (public because the render package creates an alias for this flag)

Types

type Option

type Option func(*Options)

type Options

type Options struct {
	// IncludeBulkFlags include bulk destination selection flags such as --destination-type, --environment-template, and so on
	IncludeBulkFlags bool
	// RequireDestinationOrExact requires either one of --environment or --cluster to be passed or for --exact-release to be
	// used instead of --release (since --exact-release is globally unique, as enforced by Sherlock, it is enough to find
	// the destination on its own).
	RequireDestinationOrExact bool
}

type Selection

type Selection struct {
	// IsReleaseScoped true if the user supplied the names of releases (like "agora", "cromwell"), false if they supplied "ALL"
	IsReleaseScoped bool
	// Releases is the set of matching releases
	Releases []terra.Release
	// SingleChart true if we're using a single release name
	SingleChart bool
	// AppReleasesOnly true if all matched releases are application releases
	AppReleasesOnly bool
}

Selection describes the set of releases that match user-supplied CLI flags

type Selector

type Selector struct {
	// contains filtered or unexported fields
}

func NewSelector

func NewSelector(options ...Option) *Selector

func (*Selector) AddFlags

func (s *Selector) AddFlags(cobraCommand *cobra.Command)

AddFlags adds selector CLI flags to cobra command

func (*Selector) GetSelection

func (s *Selector) GetSelection(state terra.State, pflags *pflag.FlagSet, args []string) (*Selection, error)