state

Documentation

Index

• func DefaultStatePath() string
• func DescriptionKey(projectName, branch string) string
• type State
  • func Load(path string) (*State, error)
  • func (s *State) DeleteDescription(key string)
  • func (s *State) GetDescription(key string) string
  • func (s *State) Save() error
  • func (s *State) SetDescription(key, desc string)

Functions

func DefaultStatePath

func DefaultStatePath() string

DefaultStatePath returns the default state file path.

func DescriptionKey

func DescriptionKey(projectName, branch string) string

DescriptionKey returns the key used for storing a feature's description.

Types

type State

type State struct {
	Descriptions map[string]string `yaml:"descriptions,omitempty"`
	// contains filtered or unexported fields
}

State holds persistent metadata that is not part of the config.

func Load

func Load(path string) (*State, error)

Load reads state from the given path. Returns empty state if file doesn't exist.

func (*State) DeleteDescription

func (s *State) DeleteDescription(key string)

DeleteDescription removes a description entry.

func (*State) GetDescription

func (s *State) GetDescription(key string) string

GetDescription returns the description for the given key.

func (*State) Save

func (s *State) Save() error

Save writes the state to its file path.

func (*State) SetDescription

func (s *State) SetDescription(key, desc string)

SetDescription sets or updates a description.