Details
-
Type:
Task
-
Status: To Do (View Workflow)
-
Priority:
Minor
-
Resolution: Unresolved
-
Component/s: content
-
Labels:None
-
Similar Issues:
Description
Most of the time when people use currentBuild.result, they really want the behavior from currentBuild.currentResult or currentbuild.resultIsBettterOrEqualTo/currentbuild.resultIsWorseOrEqualTo (see linked issues).
Review the existing documentation and update to use these new methods.
Attachments
Issue Links
- relates to
-
JENKINS-46325 Should we use result or currentResult?
-
- Open
-
-
JENKINS-41275 Add way to easily test currentBuild result is better/worse than some value (isBetterOrEqualTo)
-
- Closed
-
-
-
- Closed
-
- links to
Activity
| Field | Original Value | New Value |
|---|---|---|
| Link |
This issue relates to |
| Link |
This issue relates to |
| Remote Link | This issue links to "PR-31 (Web Link)" [ 17101 ] |
| Summary | Update "currentBuild.result" docs and examples to use currentBuilt.currentResult and resultIsBetter/IsWorse | Basic credentials are only supported over HTTPS secured connections |
| Summary | Basic credentials are only supported over HTTPS secured connections | Update "currentBuild.result" docs and examples to use currentBuilt.currentResult and resultIsBetter/IsWorse |
| Rank | Ranked higher |
| Description |
See linked issues. Most of the time when people use {{currentBuild.result}}, they really want the behavior from {{currentBuild.currentResult}} or {{currentbuild.resultIsBettterOrEqualTo}}/{{currentbuild.resultIsWorseOrEqualTo}}. Review the existing documentation and update to use these new methods. |
Most of the time when people use {{currentBuild.result}}, they really want the behavior from {{currentBuild.currentResult}} or {{currentbuild.resultIsBettterOrEqualTo}}/{{currentbuild.resultIsWorseOrEqualTo}} (see linked issues). Review the existing documentation and update to use these new methods. |
Exactly, one is possibly (and often) null, the other is never null. So, for one users have to use currentBuild.result == null || currentBuild.result == 'SUCCESS', the other can always be checked as currentBuild.result == 'SUCCESS'. Even better, the behavior that most users probably want is currentbuild.resultIsBettterOrEqualTo('SUCCESS') and we should suggest they use that.
OK, it's good to know that I'm starting to understand! Could you possibly comment on the reliability of reading currentResult for use in various plugin steps (JENKINS-46325)?
| Link | This issue relates to JENKINS-46325 [ JENKINS-46325 ] |
currentResult is reliable in the sense that it doesn't return null. However, it is still based on result. I've updated the referenced JIRA with additional details.
As of Pipeline: Model Definition 1.1.9, when I run the following Pipeline:
pipeline {
agent any
stages {
stage ('Init') {
steps {
echo "Init result: ${currentBuild.result}"
echo "Init currentResult: ${currentBuild.currentResult}"
}
post {
always {
echo "Post-Init result: ${currentBuild.result}"
echo "Post-Init currentResult: ${currentBuild.currentResult}"
}
}
}
stage ('Build') {
steps {
echo "During Build result: ${currentBuild.result}"
echo "During Build currentResult: ${currentBuild.currentResult}"
sh 'exit 1'
}
post {
always {
echo "Post-Build result: ${currentBuild.result}"
echo "Post-Build currentResult: ${currentBuild.currentResult}"
}
}
}
}
post {
always {
echo "Pipeline result: ${currentBuild.result}"
echo "Pipeline currentResult: ${currentBuild.currentResult}"
}
}
}
I get this output (trimmed for clarity):
Init result: null Init currentResult: SUCCESS Post-Init result: null Post-Init currentResult: SUCCESS During Build result: null During Build currentResult: SUCCESS [test-pipeline] Running shell script + exit 1 Post-Build result: FAILURE Post-Build currentResult: FAILURE Pipeline result: FAILURE Pipeline currentResult: FAILURE ERROR: script returned exit code 1 Finished: FAILURE
Please can this documentation include the information about it not being reliable inside a finally{} block, as described in the comments on JENKINS-47403?
I'm struggling to understand the difference (except that result is writable and possibly or often null, which may actually mean SUCCESS). Could you summarize?