OSS Review Toolkit package configuration

ORT's package configuration file

Type object
File match vcs.yml vcs.yaml source-artifact.yml source-artifact.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/oss-review-toolkit-package-configuration/latest.json
Source https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/package-configuration-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

The OSS-Review-Toolkit (ORT) provides a possibility to define path excludes and license finding curations for a specific package (dependency) and provenance in a package configuration file. A full list of all available options can be found at https://oss-review-toolkit.org/ort/docs/configuration/package-configurations.

Properties

id string required
license_finding_curations licenseFindingCurations[]
path_excludes object[]
vcs object
Any of: variant, variant, variant, variant
4 nested properties
path string
revision string
type string
url string
source_artifact_url string
source_code_origin enum
Values: "VCS" "ARTIFACT"

Definitions

licenseFindingCurationReason enum
licenseFindingCurations object
concluded_license string required
path string required
reason enum required
Values: "CODE" "DATA_OF" "DOCUMENTATION_OF" "INCORRECT" "NOT_DETECTED" "REFERENCE"
comment string
detected_license string
line_count integer
start_lines integer | string
pathExcludeReason enum
vcsMatcher object
path string
revision string
type string
url string