notice

type Collector ¶

type Collector interface {
	// Name is a stable identifier used in the Entry.Ecosystem field and in
	// error messages. Examples: "go", "npm".
	Name() string

	// Precheck verifies the host has what the collector needs (e.g. an
	// installed `go` toolchain, a populated `node_modules`). The returned
	// error message is shown verbatim to the user.
	Precheck(root string) error

	// Collect returns one Entry per direct dependency.
	Collect(root string) ([]Entry, error)
}

Collector enumerates one ecosystem's direct dependencies and produces NOTICE entries. Implementations live under hack/cmd/notice/internal/<ecosystem>/.

Adding a new ecosystem is three steps:

1. Create internal/<name>/ with a Collector implementation.
2. Write hermetic tests using internal/testutil for fixtures.
3. Append <name>.New() to the explicit collectors slice in main.go.

Collect MUST NOT sort its result; Build performs a global sort by Dependency across all collectors.

type Document ¶

type Document struct {
	Notices []Entry `yaml:"notices"`
}

Document is the YAML root of the NOTICE file.

func Build(root string, collectors []Collector) (*Document, error)

type Entry ¶

type Entry struct {
	Dependency string    `yaml:"dependency"`
	Ecosystem  string    `yaml:"ecosystem"`
	Copyright  []string  `yaml:"copyright"`
	License    []License `yaml:"license"`
}

Entry describes one direct dependency.

func AssembleEntry(name, ecosystem, dir, repoBase, ref, declaredLicense string) (Entry, error)

type License ¶

type License struct {
	Name string `yaml:"name"`
	Link string `yaml:"link"`
}

License attributes one license to a dependency, with a stable link to its authoritative text.