Skip to content

Commit

Permalink
feat(jenkins): Add a parameter to skip excluded scopes and paths
Browse files Browse the repository at this point in the history
Enable this by default for performance reasons of showcasing ORT. For
simplicity, only use a single parameter for all tools as there is
barely a need to configure this flag differently per tool. However, the
meaning of this parameter can slightly differ per tool, as not all tools
support e.g. path excludes yet, see [1] or also [2] in that context.

[1]: #5018
[2]: #3537

Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Feb 2, 2024
1 parent d602075 commit 90e9d36
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions integrations/jenkins/Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ pipeline {
defaultValue: ''
)

booleanParam(
name: 'SKIP_EXCLUDED',
description: 'Enable to skip scopes and paths that have been configured to be excluded, where supported.',
defaultValue: true
)

string(
name: 'ENVIRONMENT_VARIABLES',
description: 'Optional list of comma-separated key=value pairs of environment variables to set.',
Expand Down Expand Up @@ -311,7 +317,7 @@ pipeline {
steps {
withCredentials(projectVcsCredentials) {
sh '''
ORT_OPTIONS="$LOG_LEVEL"
ORT_OPTIONS="$LOG_LEVEL -P ort.downloader.skipExcluded=$SKIP_EXCLUDED"
if [ "$STACKTRACE" = "true" ]; then
ORT_OPTIONS="$ORT_OPTIONS --stacktrace"
Expand Down Expand Up @@ -471,7 +477,7 @@ pipeline {

script {
def status = sh returnStatus: true, script: '''
ORT_OPTIONS="$LOG_LEVEL -P ort.analyzer.allowDynamicVersions=$ALLOW_DYNAMIC_VERSIONS"
ORT_OPTIONS="$LOG_LEVEL -P ort.analyzer.allowDynamicVersions=$ALLOW_DYNAMIC_VERSIONS -P ort.analyzer.skipExcluded=$SKIP_EXCLUDED"
if [ -n "$ENABLED_PACKAGE_MANAGERS" ]; then
ORT_OPTIONS="$ORT_OPTIONS -P ort.analyzer.enabledPackageManagers=$ENABLED_PACKAGE_MANAGERS"
Expand Down Expand Up @@ -562,7 +568,7 @@ pipeline {
def status = sh returnStatus: true, script: '''
#!/usr/bin/env bash
ORT_OPTIONS="$LOG_LEVEL -P ort.scanner.skipConcluded=$SKIP_CONCLUDED"
ORT_OPTIONS="$LOG_LEVEL -P ort.scanner.skipExcluded=$SKIP_EXCLUDED -P ort.scanner.skipConcluded=$SKIP_CONCLUDED"
if [ "$USE_CLEARLY_DEFINED_SCAN_STORAGE" = "true" ]; then
# Configure the default local file storage explicitly to be able to refer to it.
Expand Down Expand Up @@ -689,7 +695,7 @@ pipeline {
withCredentials(projectVcsCredentials) {
script {
def status = sh returnStatus: true, script: '''
ORT_OPTIONS="$LOG_LEVEL"
ORT_OPTIONS="$LOG_LEVEL -P ort.advisor.skipExcluded=$SKIP_EXCLUDED"
if [ "$STACKTRACE" = "true" ]; then
ORT_OPTIONS="$ORT_OPTIONS --stacktrace"
Expand Down

0 comments on commit 90e9d36

Please sign in to comment.