Merge pull request #379 from marcusholl/pr/removeReturnValueFromDocuForCheckChangeInDevelopment

Remove return value from docu for step checkChangeInDevelopment
This commit is contained in:
Marcus Holl authored and GitHub committed 2018-12-07 13:15:00 +01:00
commit 5a6200f52c
1 file changed
+3 -5
@@ -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 : <changeDocumentId>`. The commit By default the git commit messages between `origin/master` and `HEAD` are scanned for a line like `ChangeDocument : <changeDocumentId>`. The commit
range and the pattern can be configured. For details see 'parameters' table. 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 ## 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. * **[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. 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 ## Exceptions
* `AbortException`: * `AbortException`: