dotlekko

Documentation

Index

• type DotLekko
  • func NewDotLekko(lekkoPath string) *DotLekko
  • func ParseDotLekko(r io.Reader) (*DotLekko, error)
  • func ReadDotLekko() (*DotLekko, error)
  • func (d *DotLekko) GetPath() string
  • func (d *DotLekko) GetRepoInfo() (string, string)
  • func (d *DotLekko) WriteBack() error

Types

type DotLekko

type DotLekko struct {
	// v1
	Version string `json:"version" yaml:"version"`
	// <owner>/<name>
	Repository string `json:"repository" yaml:"repository,omitempty"`
	// Where lekko/, the directory where config functions are managed, is in the project
	LekkoPath string `json:"lekkoPath" yaml:"lekko_path"`
	// The latest pushed commit SHA in the config repo from the perspective of the code repo.
	// Allows stable regeneration and correct 3-way merges.
	// This field is generated/managed by the CLI and should not be modified by hand.
	LockSHA string `json:"lockSHA" yaml:"lock_sha,omitempty"`
	// contains filtered or unexported fields
}

Parsed schema for .lekko config/lock file in code repos. Allows the Lekko CLI and build tools to be able to fetch/generate correct information.

func NewDotLekko

func NewDotLekko(lekkoPath string) *DotLekko

func ParseDotLekko

func ParseDotLekko(r io.Reader) (*DotLekko, error)

func ReadDotLekko

func ReadDotLekko() (*DotLekko, error)

Looks for .lekko or .lekko.(yaml|yml) in the working directory Returns the parsed configuration object and the path to the file.

func (*DotLekko) GetPath

func (d *DotLekko) GetPath() string

Get path where the dotlekko object was read from

func (*DotLekko) GetRepoInfo

func (d *DotLekko) GetRepoInfo() (string, string)

func (*DotLekko) WriteBack

func (d *DotLekko) WriteBack() error

Writes back the contents of the dotlekko object to the path it was read from