Status code docs improvements #8186
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8186 +/- ##
=========================================
Coverage 67.16% 67.16%
Complexity 2049 2049
=========================================
Files 357 357
Lines 17158 17158
Branches 2461 2461
=========================================
Hits 11525 11525
Misses 4611 4611
Partials 1022 1022
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
mnonnenmacher
requested changes
Jan 27, 2024
integrations/jenkins/Jenkinsfile
Outdated
| @@ -28,7 +28,8 @@ final DOCKER_BUILD_ARGS = '--build-arg http_proxy=$http_proxy --build-arg https_ | |||
| // Disable the entry point to work around https://issues.jenkins-ci.org/browse/JENKINS-51307. | |||
| final DOCKER_RUN_ARGS = '-e http_proxy -e https_proxy --entrypoint=""' | |||
|
|
|||
| // The status code ORT commands return for failures (like rule violations), not errors (like existing output files). | |||
| // The status code ORT CLI commands return at a minimum for failures (like rule violations), not errors (like existing | |||
There was a problem hiding this comment.
Or: "The minimum status code ORT CLI commands return..."
| @@ -108,3 +108,9 @@ const val ORT_EVALUATOR_RULES_FILENAME = "evaluator.rules.kts" | |||
| * The name of the ORT notifier script. | |||
| */ | |||
| const val ORT_NOTIFIER_SCRIPT_FILENAME = "notifier.notifications.kts" | |||
|
|
|||
| /** | |||
| * The status code ORT CLI commands return at a minimum for failures (like rule violations), not errors (like existing | |||
There was a problem hiding this comment.
"The minimum status code..."
| */ | ||
| val severeIssueThreshold: Severity = Severity.WARNING, | ||
|
|
||
| /** | ||
| * The threshold from which on rule violations count as severe. | ||
| * The threshold from which on rule violations count as severe. Severe issues cause the status code on exit of the |
There was a problem hiding this comment.
"Sever rule violations..."
sschuberth
force-pushed
the
exit-code-docs
branch
from
9146451 to
dac225e
Compare
Signed-off-by: Sebastian Schuberth <[email protected]>
This aligns with the constant in the `Jenkinsfile`. Signed-off-by: Sebastian Schuberth <[email protected]>
Signed-off-by: Sebastian Schuberth <[email protected]>
Put this next to other constants, and align to them by adding the "ORT_" prefix. Signed-off-by: Sebastian Schuberth <[email protected]>
sschuberth
force-pushed
the
exit-code-docs
branch
from
dac225e to
8866f90
Compare
mnonnenmacher
approved these changes
Jan 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please have a look at the individual commit messages for the details.