repository

Documentation

Index

• Constants
• type BadVCSURLError
  • func (b BadVCSURLError) Error() string
• type Credentials
• type Repository
  • func New(ctx context.Context, vcsURL string, credentials Credentials) (*Repository, error)
  • func (r Repository) ExtractSBOMs(ctx context.Context, includeGenericCollectors bool) (*cdx.BOM, error)
  • func (r Repository) String() string

Constants

const CheckoutsPath = "/tmp/checkouts/"

Types

type BadVCSURLError

type BadVCSURLError struct {
	URL string
}

func (BadVCSURLError) Error

func (b BadVCSURLError) Error() string

type Credentials

type Credentials struct {
	Username    string
	AccessToken string
}

type Repository

type Repository struct {
	Name       string
	FSPath     string
	CodeOwners []string
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, vcsURL string, credentials Credentials) (*Repository, error)

New clones the repository supplied in the vcsURL parameter and returns a new Repository instance. If repository is private credentials must be supplied.

func (Repository) ExtractSBOMs

func (r Repository) ExtractSBOMs(ctx context.Context, includeGenericCollectors bool) (*cdx.BOM, error)

ExtractSBOMs extracts SBOMs for every possible language from the repository. If includeGenericCollectors is set to true then additional collectors such as: syft & retirejs & cdxgen are executed against the repository as well. This tends to produce richer SBOM results

func (Repository) String

func (r Repository) String() string