MvnBuild - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

This topic lists tags that can be used with MvnBuild Pipeline steps. For more information on MvnBuild Pipeline steps, see MvnBuild.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be MvnBuild for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinent tags:

Tag	Description of usage	Required/Optional
`integrations`	Must specify an Artifactory Integration or JFrog Platform Access Token Integration.	Required
`inputResources`	Must specify a GitReporesource. The mvn command performs the build on files in the Git repository at `sourceLocation`. May also optionally specify a FileSpec resource that specifies what files to copy to `sourceLocation` to build.	Required
`outputResources`	Must specify a BuildInfo resource if `autoPublishBuildInfo` is set to `true`. If `JFROG_CLI_BUILD_NAME` or `JFROG_CLI_BUILD_NUMBER` is set as an environment variable for the pipeline or the step, that name and/or number will be used for the output BuildInfo. Otherwise, the default `buildName` and `buildNumber` are `$pipeline_name` and `$run_number.`	May be required

Tag

Description of usage

Required/Optional

integrations

Must specify an Artifactory Integration or JFrog Platform Access Token Integration.

Required

inputResources

Must specify a GitReporesource. The mvn command performs the build on files in the Git repository at sourceLocation.

May also optionally specify a FileSpec resource that specifies what files to copy to sourceLocation to build.

Required

outputResources

Must specify a BuildInfo resource if autoPublishBuildInfo is set to true. If JFROG_CLI_BUILD_NAME or JFROG_CLI_BUILD_NUMBER is set as an environment variable for the pipeline or the step, that name and/or number will be used for the output BuildInfo. Otherwise, the default buildName and buildNumber are $pipeline_name and $run_number.

May be required

In addition, these tags can be defined to support the step's native operation:

Note

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

Tag	Description of usage	Required/Optional
`mvnCommand`	Specifies a command line string of options to use with Maven. Default is `clean install`.	Optional
`sourceLocation`	Specifies the location of the source files. By default this is set to the root directory of the GitRepo resource. Defaults to the root of the GitRepo. Required if the source files are not in the root directory.	May be required
`resolverSnapshotRepo`	Artifactory repository to resolve snapshot dependencies. If set, `resolverReleaseRepo` is also required. Note Do not use with `configFileName` and `configFileLocation`.	Optional
`resolverReleaseRepo`	Artifactory repository to resolve release dependencies. If set, `resolverSnapshotRepo` is also required. Note Do not use with `configFileName` and `configFileLocation`.	Optional
`deployerSnapshotRepo`	Snapshot artifacts created by the MvnBuild are uploaded to this Artifactory repository. If set, `deployerReleaseRepo` is also required. Note Do not use with `configFileName` and `configFileLocation`.	Optional
`deployerReleaseRepo`	Release artifacts created by the MvnBuild are uploaded to this Artifactory repository. If set, deployerSnapshot`Repo` is also required. Note Do not use with `configFileName` and `configFileLocation`.	Optional
`forceXrayScan`	When set to `true`, forces an Xray scan after publishing to Artifactory. Default is `false`.	Optional
`failOnScan`	When set to `true`, and when the Xray Policy Rule Fail Build checkbox is checked in the Configure a Security Rule window, a failed Xray scan will result in a failure of the step. Default is `true`.Configure a Security Rule	Optional
`autoPublishBuildInfo`	When set to `true`, publishes build info to Artifactory. Requires a BuildInfo resources in the outputResources list. Default is `false`.	Optional
`configFileName`	Specifies the name of the JFrog CLI mvn-config file. The `serverID` in the configuration file should match the Artifactory integration name. If set, `configFileLocation`is also required. Note This option should be used only if you have committed this configuration file to your source	Optional
`configFileLocation`	Specifies the directory containing the JFrog CLI mvn-config file, relative to the `sourceLocation` . If set, `configFileName` is also required. Note This option should be used only if you have committed this configuration file to your source	Optional

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag	Description of usage	Required/Optional
`onStart`	Commands to execute in advance of the native operation	Optional
`onSuccess`	Commands to execute on successful completion	Optional
`onFailure`	Commands to execute on failed completion	Optional
`onComplete`	Commands to execute on any completion	Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.