GradleBuild

GradleBuild - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

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

name

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

type

Must be GradleBuild 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 GitRepo resource. The Gradle command will perform 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 is 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 GitRepo resource. The Gradle command will perform 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 is 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:

Tags derived from Bash

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
`gradleCommand`	Specifies a command line string of options to use with the Gradle build tool.	Required
`sourceLocation`	Location of the source files to build relative to the root of the GitRepo repository. If no path is specified, the root of the repository will be used.	Optional
`resolverRepo`	Artifactory repository to be used to resolve dependencies. May not be used with `configFileName` and `configFileLocation`.	Optional
`deployerRepo`	Artifactory repository to which to deploy. May not be used with `configFileName` and `configFileLocation`.	Optional
`usesPlugin`	Set to `true` if the Gradle Artifactory Plugin is already applied in the build script. Default is `false`. Do not use with `configFileName` and`configFileLocation` (you can enable this option directly in your existing config file).	Optional
`useWrapper`	If set to `true`, use the Gradle wrapper. Default is `false`. Do not use with `configFileName` and `configFileLocation` (you can enable this option directly in your existing config file).	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.Configure a Security Rule Default is `true`.	Optional
`autoPublishBuildInfo`	When set to `true`, publishes build info to Artifactory. Default is `false`.	Optional
`configFileName`	Gradle configuration file. If specified, the `configFileLocation` tag is also required. This file is generated using the JFrog CLI when you run `jfrog rt gradle-config` command. The `serverID` in the configuration file should match the Artifactory integration name. Note Use this option only if you have committed this configuration file to your source.	Optional
`configFileLocation`	Gradle configuration file location. A `configFileName` tag is also required. Typically stored in the `.jfrog` directory in the repository.	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.

name

type

configuration

Tags derived from Bash

Note

execution