jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-12-03 23:10:20 +02:00
Code Issues Releases Activity

Merge remote-tracking branch 'github/master' into HEAD

Browse Source
This commit is contained in:
Marcus Holl
2018-12-07 13:04:51 +01:00
parent 987584a28f 0d2277cec7
commit cc971190c9
69 changed files with 504 additions and 230 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
documentation/docs/images/setupInJenkins.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 35 KiB

2
documentation/docs/steps/checkChangeInDevelopment.md
View File

@@ -45,7 +45,7 @@ The step is configured using a customer configuration file provided as
resource in an custom shared library.
```groovy
@Library('piper-library-os@master') _
@Library('piper-lib-os@master') _
// the shared lib containing the additional configuration
// needs to be configured in Jenkins

4
documentation/docs/steps/checksPublishResults.md
View File

@@ -144,10 +144,6 @@ checksPublishResults(
![StaticChecks Thresholds](../images/StaticChecks_Threshold.png)
## Return value
none
## Side effects
If both ESLint and PyLint results are published, they are not correctly aggregated in the aggregator plugin.

2
documentation/docs/steps/cloudFoundryDeploy.md
View File

@@ -29,6 +29,7 @@ Deployment can be done
| cloudFoundry | yes | | |
| deployTool | no | cf_native | cf_native, mtaDeployPlugin |
| deployType | no | standard | standard, blue-green |
| keepOldInstance | no | false | true, false |
| dockerImage | no | s4sdk/docker-cf-cli | |
| dockerWorkspace | no | /home/piper | |
| mtaDeployParameters | | -f | |
@@ -65,6 +66,7 @@ Deployment can be done
* `deployTool` defines the tool which should be used for deployment.
* `deployType` defines the type of deployment, either `standard` deployment which results in a system downtime or a zero-downtime `blue-green` deployment.
* `keepOldInstance` in case of a `blue-green` deployment the old instance will be deleted by default. If this option is set to true the old instance will remain stopped in the Cloud Foundry space.
* `dockerImage` defines the Docker image containing the deployment tools (like cf cli, ...) and `dockerWorkspace` defines the home directory of the default user of the `dockerImage`
* `smokeTestScript` allows to specify a script which performs a check during blue-green deployment. The script gets the FQDN as parameter and returns `exit code 0` in case check returned `smokeTestStatusCode`. More details can be found [here](https://github.com/bluemixgaragelondon/cf-blue-green-deploy#how-to-use) <br /> Currently this option is only considered for deployTool `cf_native`.
* `stashContent` defines the stash names which should be unstashed at the beginning of the step. This makes the files available in case the step is started on an empty node.

4
documentation/docs/steps/dockerExecute.md
View File

@@ -69,10 +69,6 @@ In following sections the configuration is possible:
|sidecarVolumeBind||X|X|
|sidecarWorkspace||X|X|
## Return value
none
## Side effects
none

4
documentation/docs/steps/dockerExecuteOnKubernetes.md
View File

@@ -64,10 +64,6 @@ In following sections the configuration is possible:
|stashExcludes||X|X|
|stashIncludes||X|X|
## Return value
none
## Side effects
none

4
documentation/docs/steps/handlePipelineStepErrors.md
View File

@@ -46,10 +46,6 @@ none
none
## Return value
none
## Side effects
none

10
documentation/docs/steps/karmaExecuteTests.md
View File

@@ -25,7 +25,7 @@ In the Docker network, the containers can be referenced by the values provided i
| ----------|-----------|---------|-----------------|
|script|yes|||
|containerPortMappings|no|`[node:8-stretch: [[containerPort: 9876, hostPort: 9876]]]`||
|dockerEnvVars|no|||
|dockerEnvVars|no|`[ NO_PROXY: 'localhost,karma,$NO_PROXY', no_proxy: 'localhost,karma,$no_proxy']`||
|dockerImage|no|`node:8-stretch`||
|dockerName|no|`karma`||
|dockerWorkspace|no|`/home/node`||
@@ -33,11 +33,11 @@ In the Docker network, the containers can be referenced by the values provided i
|installCommand|no|`npm install --quiet`||
|modules|no|`['.']`||
|runCommand|no|`npm run karma`||
|sidecarEnvVars|no|||
|sidecarEnvVars|no|`[ NO_PROXY: 'localhost,selenium,$NO_PROXY', no_proxy: 'localhost,selenium,$no_proxy']`||
|sidecarImage|no|||
|sidecarName|no|||
|sidecarVolumeBind|no|||
|stashContent|no|||
|stashContent|no|`['buildDescriptor', 'tests']`||
- `script` - defines the global script environment of the Jenkinsfile run. Typically `this` is passed to this parameter. This allows the function to access the [`commonPipelineEnvironment`](commonPipelineEnvironment.md) for storing the measured duration.
- `containerPortMappings` - see step [dockerExecute](dockerExecute.md)
@@ -79,10 +79,6 @@ In following sections the configuration is possible:
|sidecarVolumeBind|X|X|X|
|stashContent|X|X|X|
## Return value
none
## Side effects
Step uses `seleniumExecuteTest` & `dockerExecute` inside.

4
documentation/docs/steps/mailSendNotification.md
View File

@@ -77,10 +77,6 @@ In following sections the configuration is possible:
|projectName||X|X|
|wrapInNode||X|X|
## Return value
none
## Side effects
none

4
documentation/docs/steps/mtaBuild.md
View File

@@ -48,10 +48,6 @@ The following parameters can also be specified as step parameters using the glob
* `mtaJarLocation`
* `applicationName`
## Return value
none
## Side effects
1. The file name of the resulting archive is written to the `commonPipelineEnvironment` with variable name `mtarFileName`.

4
documentation/docs/steps/neoDeploy.md
View File

@@ -95,10 +95,6 @@ The following parameters can also be specified as step parameters using the glob
* `neoCredentialsId`
* `neoHome`
## Return value
none
## Side effects
none

4
documentation/docs/steps/pipelineExecute.md
View File

@@ -30,10 +30,6 @@ none
none
## Return value
none
## Side effects
none

4
documentation/docs/steps/pipelineRestartSteps.md
View File

@@ -63,10 +63,6 @@ In following sections the configuration is possible:
|sendMail|X|X|X|
|timeoutInSeconds|X|X|X|
## Return value
none
## Side effects
none

4
documentation/docs/steps/seleniumExecuteTests.md
View File

@@ -137,10 +137,6 @@ In following sections the configuration is possible:
|stashContent|X|X|X|
|testRepository|X|X|X|
## Return value
none
## Side effects
none

4
documentation/docs/steps/setupCommonPipelineEnvironment.md
View File

@@ -26,10 +26,6 @@ Initializes the [`commonPipelineEnvironment`](commonPipelineEnvironment.md), whi
none
## Return value
none
## Side effects
none

6
documentation/docs/steps/testsPublishResults.md
View File

@@ -54,7 +54,7 @@ Each of the parameters `junit`, `jacoco`, `cobertura` and `jmeter` can be set to
| parameter | mandatory | default | possible values |
| ----------|-----------|---------|-----------------|
| pattern | no | `'**/target/surefire-reports/*.xml'` | |
| pattern | no | `'**/TEST-*.xml'` | |
| archive | no | `false` | true, false |
| updateResults | no | `false` | true, false |
| allowEmptyResults | no | `true` | true, false |
@@ -108,10 +108,6 @@ Following parameters can also be specified as step parameters using the global c
* `cobertura`
* `jmeter`
## Return value
none
## Side effects
none

4
documentation/docs/steps/toolValidate.md
View File

@@ -23,10 +23,6 @@ none
none
## Return value
none
## Side effects
none

6
documentation/docs/steps/transportRequestCreate.md
View File

@@ -7,6 +7,8 @@ Creates
* a Transport Request for a Change Document on the Solution Manager (type `SOLMAN`) or
* a Transport Request inside an ABAP system (type`CTS`)
The id of the transport request is availabe via [commonPipelineEnvironment.getTransportRequestId()](commonPipelineEnvironment.md)
## 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.
@@ -49,7 +51,7 @@ The step is configured using a customer configuration file provided as
resource in an custom shared library.
```groovy
@Library('piper-library-os@master') _
@Library('piper-lib-os@master') _
// the shared lib containing the additional configuration
// needs to be configured in Jenkins
@@ -97,7 +99,7 @@ The parameters can also be provided when the step is invoked. For examples see b
## Return value
The id of the Transport Request that has been created.
none
## Exceptions

6
documentation/docs/steps/transportRequestRelease.md
View File

@@ -41,7 +41,7 @@ The step is configured using a customer configuration file provided as
resource in an custom shared library.
```groovy
@Library('piper-library-os@master') _
@Library('piper-lib-os@master') _
// the shared lib containing the additional configuration
// needs to be configured in Jenkins
@@ -86,10 +86,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
None.
## Exceptions
* `IllegalArgumentException`:

6
documentation/docs/steps/transportRequestUploadFile.md
View File

@@ -46,7 +46,7 @@ The step is configured using a customer configuration file provided as
resource in an custom shared library.
```groovy
@Library('piper-library-os@master') _
@Library('piper-lib-os@master') _
// the shared lib containing the additional configuration
// needs to be configured in Jenkins
@@ -92,10 +92,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
None.
## Exceptions
* `IllegalArgumentException`: