OSS Review Toolkit repository configuration

ORT's repository configuration file

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

Validate with Lintel

npx @lintel/lintel check
Type: object

The OSS-Review-Toolkit (ORT) provides a possibility to configure exclusions, resolutions and more in a file called .ort.yml. A full list of all available options can be found at https://oss-review-toolkit.org/ort/docs/configuration/ort-yml.

Properties

includes object

Defines which parts of a repository should be included.

2 nested properties
paths object[]
scopes object[]
excludes object

Defines which parts of a repository should be excluded.

2 nested properties
paths object[]
scopes object[]
curations object

Curations for artifacts in a repository.

Any of: variant, variant
2 nested properties
license_findings licenseFindingCurations[]
packages Latest Curations Schema
package_configurations Latest Package Configuration Schema[]

A configuration for a specific package and provenance.

license_choices object

A configuration to select a license from a multi-licensed package.

2 nested properties
package_license_choices object[]
repository_license_choices array
snippet_choices object[]

A configuration to select a snippet from a package with multiple snippet findings.

Definitions

licenseFindingCurations object
path string required
concluded_license string required
reason enum required
Values: "CODE" "DATA_OF" "DOCUMENTATION_OF" "INCORRECT" "NOT_DETECTED" "REFERENCE"
start_lines integer | string
line_count integer
detected_license string
comment string
pathIncludeReason enum
pathExcludeReason enum
scopeIncludeReason enum
scopeExcludeReason enum
licenseFindingCurationReason enum
snippetChoiceReason enum