sbom

Documentation

Index

• type Asset
• type Options
• type SBOM
  • func NewSBOM(opts *Options) *SBOM
  • func (s *SBOM) Generate() (string, error)
  • func (s *SBOM) SetImplementation(i impl)
• type SBOMFormat

Types

type Asset

type Asset struct {
	Path     string // Path where the artifact will be listed
	ReadFrom string // LocalPath to read the information
	Label    string // Label for the asset
}

type Options

type Options struct {
	ReleaseName   string
	Repo          string
	RepoDirectory string
	Tag           string     // Version Tag
	Format        SBOMFormat // "tag-value"  | "json"
	Assets        []Asset
}

type SBOM

type SBOM struct {
	// contains filtered or unexported fields
}

func NewSBOM

func NewSBOM(opts *Options) *SBOM

NewGitHub returns a new GitHub instance.

func (*SBOM) Generate

func (s *SBOM) Generate() (string, error)

Generate creates an SBOM describing the release.

func (*SBOM) SetImplementation

func (s *SBOM) SetImplementation(i impl)

SetImplementation sets the implementation to handle file operations and SPDX.

type SBOMFormat

type SBOMFormat string

const (
	FormatJSON     SBOMFormat = "json"
	FormatTagValue SBOMFormat = "tag-value"
)