Skip to main content

Git Repository

Git

A package curation provider that loads package curations from a Git repository.

Description​

A PackageCurationProvider that loads PackageCurations from the configured Git repository.

Path layout​

The provider requires that the curation files follow the same path layout as in the ort-config repository:

  • Files with curations for a specific package must be located at [type]/[namespace]/[name].yml, based on the identifier of the package. If a component of the identifier is empty, _ is used as a placeholder. For example, for the package NuGet::Azure.Core:1.2.0, the curation file must be located at NuGet/_/Azure.Core.yml.
  • Files with curations that match all packages within a namespace must be located at [type]/[namespace]/_.yml.

Namespace-scoped curations are loaded before package-scoped curations, so that the latter can override the former.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  packageCurationProviders:
    Git:
      options:
        repositoryUrl: <OPTIONAL_STRING>
        revision: <OPTIONAL_STRING>
        path: "curations"

Options​

repositoryUrl​

STRING Required

The URL of the repository containing the curations.

revision​

STRING

The optional revision to use. If not specified, the default branch is used.

path​

STRING Default

The path relative to the repository root that contains the package curations.