mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
f757a0e1d4
* fix Markdown issue 'Headers should be surrounded by blank lines' * fix MD012 * fix MD022 * fix MD026 * fix MD007 * fix MD032 * fix MD038 * fix MD040 * fix MD031 * fix MD034 * fix MD004 * fix new findings * fix MD036 * fix MD038 * fix MD032 * fix MD006
55 lines
2.4 KiB
Markdown
55 lines
2.4 KiB
Markdown
# mavenExecute
|
|
|
|
## Description
|
|
|
|
Executes a maven command inside a Docker container.
|
|
|
|
## Parameters
|
|
|
|
| parameter | mandatory | default | example values |
|
|
| -------------------------------|-----------|-------------------|----------------------------|
|
|
| `script` | yes | | |
|
|
| `dockerImage` | no | 'maven:3.5-jdk-7' | |
|
|
| `globalSettingsFile` | no | | 'local_folder/settings.xml'|
|
|
| `projectSettingsFile` | no | | |
|
|
| `pomPath` | no | | 'local_folder/m2' |
|
|
| `flags` | no | | '-o' |
|
|
| `goals` | no | | 'clean install' |
|
|
| `m2Path` | no | | 'local_folder/m2' |
|
|
| `defines` | no | | '-Dmaven.tests.skip=true' |
|
|
| `logSuccessfulMavenTransfers` | no | `false` | 'true' |
|
|
|
|
* `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 for retrieving, for example,
|
|
configuration parameters.
|
|
* `dockerImage` Name of the docker image that should be used.
|
|
* `globalSettingsFile` Path or url to the mvn settings file that should be used as global settings file.
|
|
* `projectSettingsFile` Path or url to the mvn settings file that should be used as project settings file.
|
|
* `pomPath` Path to the pom file that should be used.
|
|
* `flags` Flags to provide when running mvn.
|
|
* `goals` Maven goals that should be executed.
|
|
* `m2Path` Path to the location of the local repository that should be used.
|
|
* `defines` Additional properties.
|
|
* `logSuccessfulMavenTransfers` configures maven to log successful downloads. This is set to `false` by default to reduce the noise in build logs.
|
|
|
|
## Step configuration
|
|
|
|
The following parameters can also be specified as step parameters using the global configuration file:
|
|
|
|
* `dockerImage`
|
|
* `globalSettingsFile`
|
|
* `projectSettingsFile`
|
|
* `pomPath`
|
|
* `m2Path`
|
|
|
|
## Exceptions
|
|
|
|
None
|
|
|
|
## Example
|
|
|
|
```groovy
|
|
mavenExecute script: this, goals: 'clean install'
|
|
```
|