github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/mavenExecute.yaml (about)

     1  metadata:
     2    name: mavenExecute
     3    description: This step allows to run maven commands
     4    longDescription: |
     5      This step runs a maven command based on the parameters provided to the step.
     6  spec:
     7    inputs:
     8      params:
     9        - name: pomPath
    10          type: string
    11          description: Path to the pom file that should be used.
    12          scope:
    13            - PARAMETERS
    14            - STEPS
    15          mandatory: false
    16        - name: goals
    17          type: "[]string"
    18          description: Maven goals that should be executed.
    19          scope:
    20            - PARAMETERS
    21          mandatory: true
    22        - name: defines
    23          type: "[]string"
    24          description: Additional properties in form of -Dkey=value.
    25          scope:
    26            - PARAMETERS
    27          mandatory: false
    28        - name: flags
    29          type: "[]string"
    30          description: Flags to provide when running mvn.
    31          scope:
    32            - PARAMETERS
    33            - STEPS
    34          mandatory: false
    35        - name: returnStdout
    36          type: bool
    37          description: Returns the output of the maven command for further processing.
    38          scope:
    39            - PARAMETERS
    40          default: false
    41  
    42        # Global maven settings, should be added to all maven steps
    43        - name: projectSettingsFile
    44          type: string
    45          description: Path to the mvn settings file that should be used as project settings file.
    46          scope:
    47            - GENERAL
    48            - STEPS
    49            - STAGES
    50            - PARAMETERS
    51          mandatory: false
    52          aliases:
    53            - name: maven/projectSettingsFile
    54        - name: globalSettingsFile
    55          type: string
    56          description: Path to the mvn settings file that should be used as global settings file.
    57          scope:
    58            - GENERAL
    59            - STEPS
    60            - STAGES
    61            - PARAMETERS
    62          mandatory: false
    63          aliases:
    64            - name: maven/globalSettingsFile
    65        - name: m2Path
    66          type: string
    67          description: Path to the location of the local repository that should be used.
    68          scope:
    69            - GENERAL
    70            - STEPS
    71            - STAGES
    72            - PARAMETERS
    73          mandatory: false
    74          aliases:
    75            - name: maven/m2Path
    76        - name: logSuccessfulMavenTransfers
    77          type: bool
    78          description: Configures maven to log successful downloads. This is set to `false` by default to reduce the noise in build logs.
    79          scope:
    80            - GENERAL
    81            - STEPS
    82            - STAGES
    83            - PARAMETERS
    84          default: false
    85          mandatory: false
    86          aliases:
    87            - name: maven/logSuccessfulMavenTransfers
    88    containers:
    89      - name: mvn
    90        image: maven:3.6-jdk-8