v1

Documentation

Index

• func NewAdvisoriesSectionUpdater(updater configs.SectionUpdater[Advisories, Document]) configs.EntryUpdater[Document]
• func NewIndex(fsys rwfs.FS) (*configs.Index[Document], error)
• func NewIndexFromPaths(fsys rwfs.FS, paths ...string) (*configs.Index[Document], error)
• type Advisories
• type Document
  • func DecodeDocument(r io.Reader) (*Document, error)
  • func (d Document) Name() string
• type Entry
• type Package

Functions

func NewAdvisoriesSectionUpdater

func NewAdvisoriesSectionUpdater(
	updater configs.SectionUpdater[Advisories, Document],
) configs.EntryUpdater[Document]

func NewIndex

func NewIndex(fsys rwfs.FS) (*configs.Index[Document], error)

func NewIndexFromPaths

func NewIndexFromPaths(fsys rwfs.FS, paths ...string) (*configs.Index[Document], error)

Types

type Advisories

type Advisories map[string][]Entry

type Document

type Document struct {
	Package Package `yaml:"package"`

	Advisories Advisories `yaml:"advisories,omitempty"`
}

func DecodeDocument

func DecodeDocument(r io.Reader) (*Document, error)

func (Document) Name

func (d Document) Name() string

type Entry

type Entry struct {
	Timestamp       time.Time         `yaml:"timestamp"`
	Status          vex.Status        `yaml:"status"`
	Justification   vex.Justification `yaml:"justification,omitempty"`
	ImpactStatement string            `yaml:"impact,omitempty"`
	ActionStatement string            `yaml:"action,omitempty"`
	FixedVersion    string            `yaml:"fixed-version,omitempty"`
}

type Package

type Package struct {
	Name string `yaml:"name"`
}