github

Documentation

Index

• Constants
• type DependencySnapshot
• type Detector
• type File
• type Job
• type Manifest
• type Metadata
• type Package
• type Writer
  • func (w Writer) Write(ctx context.Context, report types.Report) error

Constants

const (
	DirectRelationship   string = "direct"
	IndirectRelationship string = "indirect"
	RuntimeScope         string = "runtime"
	DevelopmentScope     string = "development"
)

Types

type DependencySnapshot

type DependencySnapshot struct {
	Version   int                 `json:"version"`
	Detector  Detector            `json:"detector"`
	Metadata  Metadata            `json:"metadata,omitempty"`
	Ref       string              `json:"ref,omitempty"`
	Sha       string              `json:"sha,omitempty"`
	Job       *Job                `json:"job,omitempty"`
	Scanned   string              `json:"scanned,omitempty"`
	Manifests map[string]Manifest `json:"manifests,omitempty"`
}

type Detector

type Detector struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Url     string `json:"url"`
}

type File

type File struct {
	SrcLocation string `json:"source_location,omitempty"`
}

type Job

type Job struct {
	Correlator string `json:"correlator,omitempty"`
	Id         string `json:"id,omitempty"`
}

type Manifest

type Manifest struct {
	Name     string             `json:"name,omitempty"`
	File     *File              `json:"file,omitempty"`
	Metadata Metadata           `json:"metadata,omitempty"`
	Resolved map[string]Package `json:"resolved,omitempty"`
}

type Metadata

type Metadata map[string]any

type Package

type Package struct {
	PackageUrl   string   `json:"package_url,omitempty"`
	Relationship string   `json:"relationship,omitempty"`
	Dependencies []string `json:"dependencies,omitempty"`
	Scope        string   `json:"scope,omitempty"`
	Metadata     Metadata `json:"metadata,omitempty"`
}

type Writer

type Writer struct {
	Output  io.Writer
	Version string
}

Writer generates JSON for GitHub Dependency Snapshots

func (Writer) Write

func (w Writer) Write(ctx context.Context, report types.Report) error