mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-03-05 15:15:44 +02:00
Remove not needed docu template file
This commit is contained in:
parent
8c07f69946
commit
5145f5180d
@ -1,93 +0,0 @@
|
||||
# checkChangeInDevelopment
|
||||
|
||||
## Description
|
||||
__STEP_DESCRIPTION__
|
||||
|
||||
## Parameters
|
||||
__PARAMETER_TABLE__
|
||||
|
||||
__PARAMETER_DESCRIPTION__
|
||||
|
||||
## Step configuration
|
||||
|
||||
__STEP_CONFIGURATION_SECTION__
|
||||
|
||||
The step is configured using a customer configuration file provided as
|
||||
resource in an custom shared library.
|
||||
|
||||
```
|
||||
@Library('piper-library-os@master') _
|
||||
|
||||
// the shared lib containing the additional configuration
|
||||
// needs to be configured in Jenkins
|
||||
@Library(foo@master') __
|
||||
|
||||
// inside the shared lib denoted by 'foo' the additional configuration file
|
||||
// needs to be located under 'resources' ('resoures/myConfig.yml')
|
||||
prepareDefaultValues script: this,
|
||||
customDefaults: 'myConfig.yml'
|
||||
```
|
||||
|
||||
Example content of ```'resources/myConfig.yml'``` in branch ```'master'``` of the repository denoted by
|
||||
```'foo'```:
|
||||
|
||||
```
|
||||
general:
|
||||
changeManagement:
|
||||
changeDocumentLabel: 'ChangeDocument\s?:'
|
||||
cmClientOpts: '-Djavax.net.ssl.trustStore=<path to truststore>'
|
||||
credentialsId: 'CM'
|
||||
endpoint: 'https://example.org/cm'
|
||||
git:
|
||||
from: 'HEAD~1'
|
||||
to: 'HEAD'
|
||||
format: '%b'
|
||||
```
|
||||
|
||||
The properties configured in section `'general/changeManagement'` are shared between all change managment related steps.
|
||||
|
||||
The properties can also be configured on a per-step basis:
|
||||
|
||||
```
|
||||
[...]
|
||||
steps:
|
||||
checkChangeInDevelopment:
|
||||
changeManagement:
|
||||
endpoint: 'https://example.org/cm'
|
||||
[...]
|
||||
failIfStatusIsNotInDevelopment: true
|
||||
```
|
||||
|
||||
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`:
|
||||
* If the change id is not provided via parameter and if the change document id cannot be retrieved from the commit history.
|
||||
* If the change is not in status `in development`. In this case no exception will be thrown when `failIfStatusIsNotInDevelopment` is set to `false`.
|
||||
* `IllegalArgumentException`:
|
||||
* If a mandatory property is not provided.
|
||||
## Examples
|
||||
```groovy
|
||||
// simple case. All mandatory parameters provided via
|
||||
// configuration, changeDocumentId provided via commit
|
||||
// history
|
||||
checkChangeInDevelopment script:this
|
||||
```
|
||||
|
||||
```groovy
|
||||
// explict endpoint provided, we search for changeDocumentId
|
||||
// starting at the previous commit (HEAD~1) rather than on
|
||||
// 'origin/master' (the default).
|
||||
checkChangeInDevelopment script:this
|
||||
changeManagement: [
|
||||
endpoint: 'https:example.org/cm'
|
||||
git: [
|
||||
from: 'HEAD~1'
|
||||
]
|
||||
]
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user