renovate

Documentation

Index

• Variables
• func IsKnownType(purlType string) bool
• func NewImporter() importer
• func NewParser() parser
• func ToPurl(dep Dependency) *packageurl.PackageURL
• type Dependency
  • func RetrieveAll(ctx context.Context, sqlDB *sql.DB) ([]Dependency, error)
• type DependencyUpdate
• type Diff
  • func CompareFiles(ctx context.Context, logger *slog.Logger, filename0, filename1 string) (Diff, error)
• type HashCode
• type Metadata
  • func (m Metadata) Valid() bool
• type PackageDataDependency
• type PackageDataDependencyUpdate
• type ParsingSource
• type PurlModifier
• type PurlModifierOpts
• type PurlTypeDeriver
• type Renovate
  • func (*Renovate) CreateTables(ctx context.Context, sqlDB *sql.DB) error
  • func (*Renovate) Name() string
  • func (*Renovate) QueryDistinctProjects(ctx context.Context, sqlDB *sql.DB, queryParams queries.DistinctProjectParams) ([]queries.DistinctProject, error)
  • func (*Renovate) QueryGolangCILint(ctx context.Context, sqlDB *sql.DB) (result queries.GolangCILintResult, err error)
  • func (*Renovate) QueryMostPopularDockerImages(ctx context.Context, sqlDB *sql.DB) (result queries.MostPopularDockerImagesResult, err error)
  • func (*Renovate) QueryMostPopularPackageManagers(ctx context.Context, sqlDB *sql.DB) ([]queries.MostPopularPackageManagersRow, error)
• type SimplifiedDependencyKey

Variables

var PurlModifiers []PurlModifier

var PurlTypeDerivers []PurlTypeDeriver

Functions

func IsKnownType

func IsKnownType(purlType string) bool

func NewImporter

func NewImporter() importer

func NewParser

func NewParser() parser

func ToPurl

func ToPurl(dep Dependency) *packageurl.PackageURL

Types

type Dependency

type Dependency struct {
	domain.Dependency

	Datasource string
	DepTypes   []string

	PackageType string
	PackageURL  string
}

func RetrieveAll

func RetrieveAll(ctx context.Context, sqlDB *sql.DB) ([]Dependency, error)

type DependencyUpdate

type DependencyUpdate struct {
	domain.DependencyUpdate

	Datasource string
}

type Diff

type Diff struct {
	// Notes contains any additional notes that should be presented to the user, as-is
	Notes        []string                   `json:"notes"`
	Additions    []simplifiedDependency     `json:"additions"`
	Modification []simplifiedDependencyDiff `json:"modification"`
	Deletion     []simplifiedDependency     `json:"deletion"`

	// IsNew notes whether the RepoKey being scanned was not present in the previous data (i.e. it hasn't been scanned before)
	IsNew bool `json:"isNew"`
	// IsDeletion notes whether the RepoKey being scanned is no longer present in the new data (i.e. it was previously scanned, and has now been deleted)
	IsDeletion bool `json:"isDeletion"`
}

func CompareFiles

func CompareFiles(ctx context.Context, logger *slog.Logger, filename0, filename1 string) (Diff, error)

type HashCode

type HashCode string

type Metadata

type Metadata struct {
	// ParsingSource is the underlying type of data that was parsed
	ParsingSource ParsingSource
	// Major is the major version of Renovate being used i.e. `38`
	Major *int
}

func (Metadata) Valid

func (m Metadata) Valid() bool

type PackageDataDependency

type PackageDataDependency struct {
	DepName     string `json:"depName"`
	PackageName string `json:"packageName"`
	// PackageManager comes from the map key
	Datasource     string                        `json:"datasource"`
	DepType        string                        `json:"depType"`
	DepTypes       []string                      `json:"depTypes"`
	CurrentValue   string                        `json:"currentValue"`
	LockedVersion  string                        `json:"lockedVersion"`
	FixedVersion   string                        `json:"fixedVersion"`
	CurrentVersion string                        `json:"currentVersion"`
	CurrentDigest  string                        `json:"currentDigest"`
	Updates        []PackageDataDependencyUpdate `json:"updates"`
}

type PackageDataDependencyUpdate

type PackageDataDependencyUpdate struct {
	NewVersion string `json:"newVersion"`
	NewValue   string `json:"newValue"`
	NewDigest  string `json:"newDigest"`
	UpdateType string `json:"updateType"`
}

type ParsingSource

type ParsingSource string

const (
	// ParsingSourceRenovateGraph indicates that this Renovate data was parsed from a data export produced by `renovate-graph` (https://gitlab.com/tanna.dev/renovate-graph/)
	ParsingSourceRenovateGraph ParsingSource = "renovate-graph"
	// ParsingSourceRenovateReport indicates that this Renovate was produced by a Renovate report (see https://dmd.tanna.dev/cookbooks/consuming-renovate-debug-logs/ for more details)
	ParsingSourceRenovateReport ParsingSource = "renovate-report"
	// ParsingSourceRenovateDebugLogs indicates that this Renovate was produced by parsing the debug logs from a Renovate instance (see https://dmd.tanna.dev/cookbooks/consuming-renovate-report/for more details)
	ParsingSourceRenovateDebugLogs ParsingSource = "renovate-debug-logs"
)

type PurlModifier

type PurlModifier func(in PurlModifierOpts, dep Dependency) (result PurlModifierOpts, found bool)

type PurlModifierOpts

type PurlModifierOpts struct {
	PurlType  string
	Namespace string
	Name      string
	Version   string
}

type PurlTypeDeriver

type PurlTypeDeriver func(packageManager string, datasource string) (purlType string, found bool)

type Renovate

type Renovate struct{}

func (*Renovate) CreateTables

func (*Renovate) CreateTables(ctx context.Context, sqlDB *sql.DB) error

func (*Renovate) Name

func (*Renovate) Name() string

func (*Renovate) QueryDistinctProjects

func (*Renovate) QueryDistinctProjects(ctx context.Context, sqlDB *sql.DB, queryParams queries.DistinctProjectParams) ([]queries.DistinctProject, error)

func (*Renovate) QueryGolangCILint

func (*Renovate) QueryGolangCILint(ctx context.Context, sqlDB *sql.DB) (result queries.GolangCILintResult, err error)

func (*Renovate) QueryMostPopularDockerImages

func (*Renovate) QueryMostPopularDockerImages(ctx context.Context, sqlDB *sql.DB) (result queries.MostPopularDockerImagesResult, err error)

func (*Renovate) QueryMostPopularPackageManagers

func (*Renovate) QueryMostPopularPackageManagers(ctx context.Context, sqlDB *sql.DB) ([]queries.MostPopularPackageManagersRow, error)

type SimplifiedDependencyKey

type SimplifiedDependencyKey string

SimplifiedDependencyKey is a map key for a given SimplifiedDependency, which takes into account key metadata for a SimplifiedDependency for the purpose of partial deduplication