@@ -53,39 +53,53 @@ variables:
53
53
git, mercurial or subversion)
54
54
ORT_CONFIG_FILE :
55
55
value : " "
56
- description : " Path to repository configuration file relative to the VCS root. If empty '.ort.yml' is used as default."
56
+ description : |
57
+ Path to repository configuration file relative to the VCS root.
58
+ By default set to '.ort.yml'.
57
59
ORT_ALLOW_DYNAMIC_VERSIONS :
58
60
value : " "
59
61
description : |
60
62
Set to 'true' only if dynamic dependency versions are allowed (note version ranges specified for dependencies may cause unstable results).
61
63
This field applies only to package managers that support lock files, e.g. NPM.
64
+ By default set to 'false'.
62
65
DISABLE_SHALLOW_CLONE :
63
66
value : " "
64
67
description : |
65
68
If set to 'true', the full history of the project is cloned. This option works only if VCS_TYPE is 'git'.
66
- Check this option only if you know that it is required for your scan.
69
+ Check this option only if you know that it is required for your scan. By default set to 'false'.
67
70
FAIL_ON_OUTDATED_NOTICE_FILE :
68
71
value : " false"
69
72
description : " If set to 'true', the scan will be considered as failed if generated NOTICE file differs from the one in your repository."
70
73
NOTICE_FILE :
71
74
value : " "
72
- description : " Path to open source attribution document relative to the VCS root. If empty 'FOSS_NOTICE' is used as default."
75
+ description : |
76
+ Path to open source attribution document relative to the VCS root.
77
+ By default set to 'FOSS_NOTICE'.
73
78
ORT_CONFIG_REVISION :
74
79
value : " "
75
80
description : |
76
81
The Git revision of the ORT configuration repository to use.
82
+ By default set to 'main'.
77
83
ORT_DISABLE_ADVISOR :
78
84
value : " "
79
- description : " If set to 'true', ORT's advisor will not run (no security vulnerability checks)."
85
+ description : |
86
+ If set to 'true', ORT's advisor will not run (no security vulnerability checks).
87
+ By default set to 'false'.
80
88
ORT_DISABLE_EVALUATOR :
81
89
value : " "
82
- description : " If set to 'true', ORT's evaluator will not run (no policy checks)."
90
+ description : |
91
+ If set to 'true', ORT's evaluator will not run (no policy checks).
92
+ By default set to 'true'.
83
93
ORT_DISABLE_SCANNER :
84
94
value : " "
85
- description : " If set to 'true', ORT's scanner will not run (no copyright holders and licenses scan)."
95
+ description : |
96
+ If set to 'true', ORT's scanner will not run (no copyright holders and licenses scan).
97
+ By default set to 'false'.
86
98
ORT_LOG_LEVEL :
87
99
value : " "
88
- description : " Set value to 'debug' to see additional debug output to help tracking down errors. If empty 'performance' is used as default."
100
+ description : |
101
+ Set value to 'debug' to see additional debug output to help tracking down errors.
102
+ By default set to 'performance'.
89
103
ORT_REVISION :
90
104
value : " "
91
105
description : |
0 commit comments