metadata

Documentation

Index

• Constants
• type KEP
  • func FromBytes(b []byte) (KEP, error)
  • func New(authors []string, title string, routingInfo routingInfoProvider) (KEP, error)
  • func Open(p string) (KEP, error)

Constants

const (
	UnsetShortID = -1
)

Types

type KEP

type KEP interface {
	UniqueID() string
	Authors() []string
	Title() string
	ShortID() int
	Reviewers() []string
	Approvers() []string
	Editors() []string
	State() states.Name
	DevelopmentThemes() []string
	SectionLocations() []string // really are section paths

	// should be (string) references to other KEPs
	Replaces() []string
	SupersededBy() []string

	Created() time.Time
	LastUpdated() time.Time

	// Flattened routing info
	OwningSIG() string
	AffectedSubprojects() []string
	ParticipatingSIGs() []string
	KubernetesWide() bool
	SIGWide() bool
	ContentDir() string

	// Mutators (locking)
	SetState(states.Name)
	AddSectionLocations([]string)
	AddApprovers([]string)
	AddReviewers([]string)
	Persist() error

	// External locking support
	sync.Locker
}

func FromBytes

func FromBytes(b []byte) (KEP, error)

func New

func New(authors []string, title string, routingInfo routingInfoProvider) (KEP, error)

func Open

func Open(p string) (KEP, error)