feat(jenkins): Add a parameter to skip excluded scopes and paths #8219
Conversation
integrations/jenkins/Jenkinsfile
Outdated
| @@ -97,6 +97,12 @@ pipeline { | |||
| defaultValue: '' | |||
| ) | |||
|
|
|||
| booleanParam( | |||
| name: 'SKIP_EXCLUDED', | |||
| description: 'Enable to skip scopes and paths that have been excluded via configuration.', | |||
There was a problem hiding this comment.
Question: One what granularity does the "excluding paths" work? (file vs. project)
If the latter, would the comment be clearer if it said: "Enable to skip excluded scopes, projects and packages." ?
There was a problem hiding this comment.
One what granularity does the "excluding paths" work? (file vs. project)
While of the tools are you referring to specifically?
There was a problem hiding this comment.
The scanner. The scanner won't skip excluded paths, which is why I proposed the alternative comment.
There was a problem hiding this comment.
The scanner won't skip excluded paths
For reference, that's #5018 BTW.
which is why I proposed the alternative comment.
"Enable to skip excluded scopes, projects and packages."
As packages cannot be excluded on their own either, this wording has problems as well. I'll think of something else and update the PR.
There was a problem hiding this comment.
Packages can be excluded by either a scope exclude or by a path exclude matching the project's definition file.
There was a problem hiding this comment.
Packages can be excluded by either a scope exclude or by a path exclude
Exactly. So packages are never excluded explicitly, but only implicitly via scopes or via projects. My goal was to not document this "implictness", but focus on the first-party entities that we can explicitly exclude. I'm open for other wordings that consider this.
There was a problem hiding this comment.
I believe it's clearer to speak about "what" is excluded (package, project) rather than about "how" its being excluded (scope exclude, path exclude). But I'll leave it up to you.
There was a problem hiding this comment.
I believe it's clearer to speak about "what" is excluded (package, project)
In terms of ORT configuration, we have "scope excludes" and "path excludes", so to me "scope" and "path" are the "what" here, as those are the entities the user has to deal with.
While you were approving, I came up with
Enable to skip scopes and paths (and affected packages / projects) that have been configured to be excluded.
Would that be better than the current wording in your eyes?
There was a problem hiding this comment.
I don't have an opinion on that one. A bit similar. But let's just do as you prefer, it's too opinionated I guess
There was a problem hiding this comment.
I had pushed this here for reference, but decided to close it.
sschuberth
force-pushed
the
jenkins-skip-excluded-parameter
branch
from
d57cdbd to
4f37e6e
Compare
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]>
sschuberth
force-pushed
the
jenkins-skip-excluded-parameter
branch
from
4f37e6e to
b33d3ad
Compare
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.