1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/resources/metadata/mavenBuild.yaml

167 lines
6.4 KiB
YAML
Raw Normal View History

2020-02-28 14:09:46 +02:00
metadata:
2020-03-13 14:32:37 +02:00
name: mavenBuild
aliases:
- name: mavenExecute
deprecated: false
2020-03-13 14:32:37 +02:00
description: This step will install the maven project into the local maven repository.
2020-02-28 14:09:46 +02:00
longDescription: |
2020-03-13 14:32:37 +02:00
This step will install the maven project into the local maven repository.
It will also prepare jacoco to record the code coverage and
supports ci friendly versioning by flattening the pom before installing.
2020-02-28 14:09:46 +02:00
spec:
inputs:
secrets:
- name: altDeploymentRepositoryPasswordId
description: Jenkins credentials ID containing the artifact deployment repository password.
type: jenkins
2020-02-28 14:09:46 +02:00
params:
- name: pomPath
type: string
2020-03-13 14:32:37 +02:00
description: Path to the pom file which should be installed including all children.
2020-02-28 14:09:46 +02:00
scope:
- PARAMETERS
- STEPS
mandatory: false
2020-03-13 14:32:37 +02:00
default: pom.xml
- name: flatten
type: bool
description: Defines if the pom files should be flattened to support ci friendly maven versioning.
scope:
- PARAMETERS
default: true
- name: verify
type: bool
description: Instead of installing the artifact only the verify lifecycle phase is executed.
scope:
- PARAMETERS
default: false
2020-03-17 13:09:08 +02:00
# Global maven settings, should be added to all maven steps
2020-02-28 14:09:46 +02:00
- name: projectSettingsFile
type: string
description: Path to the mvn settings file that should be used as project settings file.
scope:
2020-03-17 13:09:08 +02:00
- GENERAL
2020-02-28 14:09:46 +02:00
- STEPS
2020-03-17 13:09:08 +02:00
- STAGES
- PARAMETERS
aliases:
- name: maven/projectSettingsFile
2020-02-28 14:09:46 +02:00
- name: globalSettingsFile
type: string
description: Path to the mvn settings file that should be used as global settings file.
scope:
2020-03-17 13:09:08 +02:00
- GENERAL
2020-02-28 14:09:46 +02:00
- STEPS
2020-03-17 13:09:08 +02:00
- STAGES
- PARAMETERS
aliases:
- name: maven/globalSettingsFile
resourceRef:
- name: commonPipelineEnvironment
param: custom/mavenGlobalSettingsFile
2020-02-28 14:09:46 +02:00
- name: m2Path
type: string
description: Path to the location of the local repository that should be used.
scope:
2020-03-17 13:09:08 +02:00
- GENERAL
2020-02-28 14:09:46 +02:00
- STEPS
2020-03-17 13:09:08 +02:00
- STAGES
- PARAMETERS
aliases:
- name: maven/m2Path
2020-02-28 14:09:46 +02:00
- name: logSuccessfulMavenTransfers
type: bool
description: Configures maven to log successful downloads. This is set to `false` by default to reduce the noise in build logs.
scope:
2020-03-17 13:09:08 +02:00
- GENERAL
- STEPS
- STAGES
2020-02-28 14:09:46 +02:00
- PARAMETERS
default: false
2020-03-17 13:09:08 +02:00
aliases:
- name: maven/logSuccessfulMavenTransfers
- name: createBOM
type: bool
description: Creates the bill of materials (BOM) using CycloneDX Maven plugin.
scope:
- GENERAL
- STEPS
- STAGES
- PARAMETERS
default: false
aliases:
- name: maven/createBOM
- name: altDeploymentRepositoryPassword
type: string
description: Password for the alternative deployment repository to which the project artifacts should be deployed ( other than those specified in <distributionManagement> ). This password will be updated in settings.xml . When no settings.xml is provided a new one is created corresponding with <servers> tag
scope:
- GENERAL
- PARAMETERS
- STAGES
- STEPS
secret: true
resourceRef:
- name: commonPipelineEnvironment
param: custom/repositoryPassword
- name: altDeploymentRepositoryPasswordId
type: secret
- type: vaultSecretFile
paths:
- $(vaultPath)/alt-deployment-repository-passowrd
- $(vaultBasePath)/$(vaultPipelineName)/alt-deployment-repository-passowrd
- $(vaultBasePath)/GROUP-SECRETS/alt-deployment-repository-passowrd
- name: altDeploymentRepositoryUser
type: string
description: User for the alternative deployment repository to which the project artifacts should be deployed ( other than those specified in <distributionManagement> ). This user will be updated in settings.xml . When no settings.xml is provided a new one is created corresponding with <servers> tag
scope:
- GENERAL
- PARAMETERS
- STAGES
- STEPS
resourceRef:
- name: commonPipelineEnvironment
param: custom/repositoryUsername
- name: altDeploymentRepositoryUrl
type: string
description: Url for the alternative deployment repository to which the project artifacts should be deployed ( other than those specified in <distributionManagement> ). This Url will be updated in settings.xml . When no settings.xml is provided a new one is created corresponding with <servers> tag
scope:
- GENERAL
- PARAMETERS
- STAGES
- STEPS
resourceRef:
- name: commonPipelineEnvironment
param: custom/repositoryUrl
- name: altDeploymentRepositoryID
type: string
description: Id for the alternative deployment repository to which the project artifacts should be deployed ( other than those specified in <distributionManagement> ). This id will be updated in settings.xml and will be used as a flag with DaltDeploymentRepository along with mavenAltDeploymentRepositoryUrl during maven deploy . When no settings.xml is provided a new one is created corresponding with <servers> tag
scope:
- GENERAL
- PARAMETERS
- STAGES
- STEPS
resourceRef:
- name: commonPipelineEnvironment
param: custom/repositoryId
- name: customTlsCertificateLinks
type: "[]string"
description: "List of download links to custom TLS certificates. This is required to ensure trusted connections to instances with repositories (like nexus) when publish flag is set to true."
scope:
- PARAMETERS
- STAGES
- STEPS
- name: publish
type: bool
description: Configures maven to run the deploy plugin to publish artifacts to a repository.
scope:
- STEPS
- STAGES
- PARAMETERS
default: false
aliases:
- name: maven/publish
2020-03-17 13:09:08 +02:00
containers:
- name: mvn
image: maven:3.6-jdk-8