secrets

Documentation

Index

• func DefineGetters(s *creds.Secure)
• func DefineSetters(s *creds.Secure)
• type Context
  • func (s *Context) Flag(name string, flag *kingpin.FlagClause) (cliFlag *kingpinCli.FlagClause)
  • func (s *Context) GetStringValue(field string) (value string, found, isDefault bool, _ error)
• type Secrets
  • func (s *Secrets) Action(action string)
  • func (s *Secrets) DefineContext(context clier.ParseContexter)
  • func (s *Secrets) GetStringValue(field string) (value string, found, isDefault bool, _ error)
  • func (s *Secrets) Init(app *kingpin.Application, forjfile *forjfile.Forge, drivers *drivers.Drivers, ...)

Functions

func DefineGetters

func DefineGetters(s *creds.Secure)

DefineGetters define the list of secrets value setters (ex: copied-from, link-to)

func DefineSetters

func DefineSetters(s *creds.Secure)

DefineSetters define the list of secrets value setters (ex: copied-from, link-to)

Types

type Context

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

Context store the Forjj cli context.

func (*Context) Flag

func (s *Context) Flag(name string, flag *kingpin.FlagClause) (cliFlag *kingpinCli.FlagClause)

Create a cli flag from a kingpin flag (for forjj-modules/cli)

func (*Context) GetStringValue

func (s *Context) GetStringValue(field string) (value string, found, isDefault bool, _ error)

GetStringValue return value and status where the value were found.

WARNING: Default status can be set only in cli load context phase (before parse) If we need to incorporate some data feed between real value and default value it must be done and saved during load context phase. (ie ParseContext() in cli_context.go)

type Secrets

type Secrets struct {
	Context Context
	// contains filtered or unexported fields
}

func (*Secrets) Action

func (s *Secrets) Action(action string)

func (*Secrets) DefineContext

func (s *Secrets) DefineContext(context clier.ParseContexter)

DefineContext define cli Context to permit ParseContext to retrieve common variable set.

func (*Secrets) GetStringValue

func (s *Secrets) GetStringValue(field string) (value string, found, isDefault bool, _ error)

GetStringValue Return a field value from the given context (parse time, or after)

func (*Secrets) Init

func (s *Secrets) Init(app *kingpin.Application, forjfile *forjfile.Forge, drivers *drivers.Drivers, secrets *creds.Secure, isParsePhase func() bool, initCommon func(context *Context, cmd *kingpin.CmdClause))

Init initialize the secrets cli commands