From 987584a28f8a0868137a2962e2c000b357d1f6ff Mon Sep 17 00:00:00 2001 From: Marcus Holl Date: Fri, 9 Nov 2018 16:10:01 +0100 Subject: [PATCH] Remove return value from docu for step checkChangeInDevelopment --- documentation/docs/steps/checkChangeInDevelopment.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/documentation/docs/steps/checkChangeInDevelopment.md b/documentation/docs/steps/checkChangeInDevelopment.md index a850cfa07..4d5bbb428 100644 --- a/documentation/docs/steps/checkChangeInDevelopment.md +++ b/documentation/docs/steps/checkChangeInDevelopment.md @@ -8,6 +8,9 @@ can also be provided via parameter `changeDocumentId`. Any value provided as par By default the git commit messages between `origin/master` and `HEAD` are scanned for a line like `ChangeDocument : `. The commit range and the pattern can be configured. For details see 'parameters' table. +In case the change is not in status 'in development' an `hudson.AbortException` is thrown. In case `failIfStatusIsNotInDevelopment` +is set to `false`, no `hudson.AbortException` will be thrown. In this case there is only a message in the log stating the change is not in status 'in development'. + ## Prerequisites * **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central. @@ -86,11 +89,6 @@ The properties can also be configured on a per-step basis: The parameters can also be provided when the step is invoked. For examples see below. -## Return value - -`true` in case the change document is in status 'in development'. Otherwise an hudson.AbortException is thrown. In case `failIfStatusIsNotInDevelopment` -is set to `false`, `false` is returned in case the change document is not in status 'in development' - ## Exceptions * `AbortException`: