The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
ArtifactoryGradleBuild
: run Artifactory gradleMavenDescriptorStep
: Get Artifactory Maven descriptoraddInteractivePromotion
: Add interactive promotionartifactoryBuildTrigger
: Trigger Artifactory buildartifactoryDistributeBuild
: Distribute buildartifactoryDownload
: Download artifactsartifactoryEditProps
: Edit propertiesartifactoryGoPublish
: Run Artifactory Go Publish commandartifactoryGoRun
: Run Artifactory Go commandartifactoryMavenBuild
: run Artifactory mavenartifactoryNpmCi
: Run Artifactory npm ciartifactoryNpmInstall
: Run Artifactory npm installartifactoryNpmPublish
: Run Artifactory npm publishartifactoryNugetRun
: Run Artifactory NuGetartifactoryPipRun
: Run Artifactory pip installartifactoryPromoteBuild
: Promote buildartifactoryUpload
: Upload artifactsbuildAppend
: Build appendcollectEnv
: Collect environment variables and system propertiescollectIssues
: Collect issues from git and add them to a buildconanAddRemote
: Add new repo to Conan configconanAddUser
: Add new user to Conan configcreateDockerBuildStep
: Artifactory create Docker buildcreateReleaseBundle
: Create a release bundledeleteReleaseBundle
: Delete a release bundledeployArtifacts
: Deploy artifactsdistributeReleaseBundle
: Distribute a release bundledockerPullStep
: Artifactory docker pulldockerPushStep
: Artifactory docker pushdsCreateReleaseBundle
: Create release bundledsDeleteReleaseBundle
: Delete a release bundledsDistributeReleaseBundle
: Distribute a release bundledsSignReleaseBundle
: Sign a release bundledsUpdateReleaseBundle
: Update a release bundlegetArtifactoryServer
: Get Artifactory server from Jenkins configgetJFrogPlatformInstance
: Get JFrog Platform instance from Jenkins configinitConanClient
: Create Conan ClientjfPipelines
: Set output resources and report results for JFrog PipelinesjfrogInstance
: Creates new JFrog instancenewArtifactoryServer
: Returns new Artifactory servernewBuildInfo
: New buildInfonewGoBuild
: New Artifactory GonewGradleBuild
: New Artifactory gradle executornewJFrogPlatformInstance
: Returns new JFrog platform instancenewMavenBuild
: New Artifactory mavennewNpmBuild
: New Artifactory npm executornewNugetBuild
: New Artifactory NuGet executornewPipBuild
: New Artifactory pip executorpublishBuildInfo
: Publish build Info to ArtifactoryrtAddInteractivePromotion
: Add interactive promotionrtBuildAppend
: Build appendrtBuildInfo
: Create build infortBuildTrigger
: Trigger Artifactory buildrtCollectIssues
: Collect issuesrtConanClient
: Creates new Conan clientrtConanRemote
: Add new repo to Conan configrtConanRun
: Run a Conan commandrtCreateDockerBuild
: run Artifactory create Docker buildrtDeleteProps
: Delete propertiesrtDockerPull
: run Artifactory docker pullrtDockerPush
: run Artifactory docker pushrtDotnetResolver
: set .NET resolverrtDotnetRun
: run Artifactory .NETrtDownload
: Download artifactsrtGoDeployer
: set go deployerrtGoPublish
: run Artifactory Go publishrtGoResolver
: set Go resolverrtGoRun
: run Artifactory Go publishrtGradleDeployer
: set gradle deployerrtGradleResolver
: set gradle resolverrtGradleRun
: run Artifactory gradlertMavenDeployer
: set maven deployerrtMavenResolver
: set maven resolverrtMavenRun
: run Artifactory mavenrtNpmCi
: run Artifactory npm cirtNpmDeployer
: set npm deployerrtNpmInstall
: run Artifactory npm installrtNpmPublish
: run Artifactory npm publishrtNpmResolver
: set npm resolverrtNugetResolver
: set NuGet resolverrtNugetRun
: run Artifactory NuGetrtPipInstall
: run Artifactory pip installrtPipResolver
: set pip resolverrtPromote
: Promote buildrtPublishBuildInfo
: Publish build infortServer
: Creates new Artifactory serverrtSetProps
: Set propertiesrtUpload
: Upload artifactsrunConanCommand
: Run a Conan commandsignReleaseBundle
: Sign a release bundleupdateReleaseBundle
: Update a release bundlexrayScan
: run Xray scanxrayScanBuild
: Xray build scanningArtifactoryGradleBuild
: run Artifactory gradlegradleBuild
class org.jfrog.hudson.pipeline.common.types.builds.GradleBuild
rootDir : String
buildFile : String
tasks : String
switches : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
MavenDescriptorStep
: Get Artifactory Maven descriptorpomFile : String
version : String
versionPerModule
java.util.Map<java.lang.String, java.lang.String>
failOnSnapshot : boolean
dryRun : boolean
addInteractivePromotion
: Add interactive promotionpromotionConfig
class org.jfrog.hudson.pipeline.common.types.PromotionConfig
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
displayName : String
artifactoryBuildTrigger
: Trigger Artifactory buildserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
paths : String
spec : String
artifactoryDistributeBuild
: Distribute builddistributionConfig
class org.jfrog.hudson.pipeline.common.types.DistributionConfig
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
artifactoryDownload
: Download artifactsspec : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
failNoOp : boolean
module : String
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
artifactoryEditProps
: Edit propertiesspec : String
props : String
failNoOp : boolean
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
editType
SET
, DELETE
artifactoryGoPublish
: Run Artifactory Go Publish commandbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
goBuild
class org.jfrog.hudson.pipeline.common.types.builds.GoBuild
path : String
version : String
args : String
module : String
javaArgs : String
artifactoryGoRun
: Run Artifactory Go commandbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
goBuild
class org.jfrog.hudson.pipeline.common.types.builds.GoBuild
path : String
goCmdArgs : String
args : String
module : String
javaArgs : String
artifactoryMavenBuild
: run Artifactory mavenmavenBuild
class org.jfrog.hudson.pipeline.common.types.builds.MavenBuild
pom : String
goals : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
artifactoryNpmCi
: Run Artifactory npm cibuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
npmBuild
class org.jfrog.hudson.pipeline.common.types.builds.NpmBuild
javaArgs : String
path : String
args : String
module : String
artifactoryNpmInstall
: Run Artifactory npm installbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
npmBuild
class org.jfrog.hudson.pipeline.common.types.builds.NpmBuild
javaArgs : String
path : String
args : String
module : String
artifactoryNpmPublish
: Run Artifactory npm publishbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
npmBuild
class org.jfrog.hudson.pipeline.common.types.builds.NpmBuild
path : String
javaArgs : String
args : String
module : String
artifactoryNugetRun
: Run Artifactory NuGetbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
nugetBuild
class org.jfrog.hudson.pipeline.common.types.builds.NugetBuild
javaArgs : String
args : String
module : String
artifactoryPipRun
: Run Artifactory pip installbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
pipBuild
class org.jfrog.hudson.pipeline.common.types.builds.PipBuild
javaArgs : String
args : String
envActivation : String
module : String
artifactoryPromoteBuild
: Promote buildpromotionConfig
class org.jfrog.hudson.pipeline.common.types.PromotionConfig
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
artifactoryUpload
: Upload artifactsspec : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
failNoOp : boolean
module : String
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
buildAppend
: Build appendbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
buildName : String
buildNumber : String
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
collectEnv
: Collect environment variables and system propertiesenv
class org.jfrog.hudson.pipeline.common.types.buildInfo.Env
collectIssues
: Collect issues from git and add them to a buildissues
class org.jfrog.hudson.pipeline.common.types.buildInfo.Issues
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
config : String
conanAddRemote
: Add new repo to Conan configserverUrl : String
serverName : String
conanHome : String
force : boolean
verifySSL : boolean
conanAddUser
: Add new user to Conan configserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
serverName : String
conanHome : String
createDockerBuildStep
: Artifactory create Docker buildkanikoImageFile : String
jibImageFiles : String
sourceRepo : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
javaArgs : String
createReleaseBundle
: Create a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServer
name : String
version : String
spec : String
storingRepo : String
signImmediately : boolean
dryRun : boolean
gpgPassphrase : String
releaseNotesPath : String
releaseNotesSyntax : String
description : String
deleteReleaseBundle
: Delete a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServer
name : String
version : String
dryRun : boolean
sync : boolean
deleteFromDist : boolean
distRules : String
countryCodes : Array / List of String
siteName : String
cityName : String
deployArtifacts
: Deploy artifactsdeployer
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
distributeReleaseBundle
: Distribute a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServer
name : String
version : String
dryRun : boolean
sync : boolean
distRules : String
countryCodes : Array / List of String
siteName : String
cityName : String
dockerPullStep
: Artifactory docker pullimage : String
host : String
sourceRepo : String
javaArgs : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
dockerPushStep
: Artifactory docker pushimage : String
host : String
targetRepo : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
properties
com.google.common.collect.ArrayListMultimap<java.lang.String, java.lang.String>
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
javaArgs : String
dsCreateReleaseBundle
: Create release bundleserverId : String
name : String
version : String
spec : String
description : String
(optional)
dryRun : boolean
(optional)
gpgPassphrase : String
(optional)
releaseNotesPath : String
(optional)
releaseNotesSyntax : String
(optional)
signImmediately : boolean
(optional)
specPath : String
(optional)
storingRepo : String
(optional)
dsDeleteReleaseBundle
: Delete a release bundleserverId : String
name : String
version : String
cityName : String
(optional)
countryCodes : Array / List of String
(optional)
deleteFromDist : boolean
(optional)
distRules : String
(optional)
dryRun : boolean
(optional)
siteName : String
(optional)
sync : boolean
(optional)
dsDistributeReleaseBundle
: Distribute a release bundleserverId : String
name : String
version : String
cityName : String
(optional)
countryCodes : Array / List of String
(optional)
distRules : String
(optional)
dryRun : boolean
(optional)
siteName : String
(optional)
sync : boolean
(optional)
dsSignReleaseBundle
: Sign a release bundleserverId : String
name : String
version : String
gpgPassphrase : String
(optional)
storingRepo : String
(optional)
dsUpdateReleaseBundle
: Update a release bundleserverId : String
name : String
version : String
spec : String
description : String
(optional)
dryRun : boolean
(optional)
gpgPassphrase : String
(optional)
releaseNotesPath : String
(optional)
releaseNotesSyntax : String
(optional)
signImmediately : boolean
(optional)
specPath : String
(optional)
storingRepo : String
(optional)
initConanClient
: Create Conan Clientclient
class org.jfrog.hudson.pipeline.common.types.ConanClient
jfPipelines
: Set output resources and report results for JFrog PipelinesoutputResources : String
(optional)
reportStatus : String
(optional)
jfrogInstance
: Creates new JFrog instanceid : String
artifactoryUrl : String
(optional)
bypassProxy : boolean
(optional)
credentialsId : String
(optional)
deploymentThreads : int
(optional)
distributionUrl : String
(optional)
password : String
(optional)
retry : int
(optional)
timeout : int
(optional)
url : String
(optional)
username : String
(optional)
newArtifactoryServer
: Returns new Artifactory serverurl : String
username : String
password : String
credentialsId : String
newJFrogPlatformInstance
: Returns new JFrog platform instanceurl : String
artifactoryUrl : String
distributionUrl : String
username : String
password : String
credentialsId : String
publishBuildInfo
: Publish build Info to ArtifactorybuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
rtAddInteractivePromotion
: Add interactive promotionserverId : String
buildName : String
(optional)
buildNumber : String
(optional)
comment : String
(optional)
copy : boolean
(optional)
displayName : String
(optional)
failFast : boolean
(optional)
includeDependencies : boolean
(optional)
project : String
(optional)
sourceRepo : String
(optional)
status : String
(optional)
targetRepo : String
(optional)
rtBuildAppend
: Build appendserverId : String
appendBuildName : String
appendBuildNumber : String
buildName : String
(optional)
buildNumber : String
(optional)
project : String
(optional)
rtBuildInfo
: Create build infoasyncBuildRetention : boolean
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
captureEnv : boolean
(optional)
deleteBuildArtifacts : boolean
(optional)
doNotDiscardBuilds : Array / List of String
(optional)
excludeEnvPatterns : Array / List of String
(optional)
includeEnvPatterns : Array / List of String
(optional)
maxBuilds : int
(optional)
maxDays : int
(optional)
project : String
(optional)
startDate
(optional)
class java.util.Date
rtCollectIssues
: Collect issuesserverId : String
buildName : String
(optional)
buildNumber : String
(optional)
config : String
(optional)
configPath : String
(optional)
project : String
(optional)
rtConanRemote
: Add new repo to Conan configclientId : String
name : String
serverId : String
repo : String
force : boolean
(optional)
verifySSL : boolean
(optional)
rtConanRun
: Run a Conan commandclientId : String
command : String
buildName : String
(optional)
buildNumber : String
(optional)
project : String
(optional)
rtCreateDockerBuild
: run Artifactory create Docker buildserverId : String
sourceRepo : String
buildName : String
(optional)
buildNumber : String
(optional)
javaArgs : String
(optional)
jibImageFiles : String
(optional)
kanikoImageFile : String
(optional)
project : String
(optional)
rtDeleteProps
: Delete propertiesserverId : String
failNoOp : boolean
(optional)
props : String
(optional)
spec : String
(optional)
specPath : String
(optional)
rtDockerPull
: run Artifactory docker pullserverId : String
image : String
sourceRepo : String
buildName : String
(optional)
buildNumber : String
(optional)
host : String
(optional)
javaArgs : String
(optional)
project : String
(optional)
rtDockerPush
: run Artifactory docker pushserverId : String
image : String
targetRepo : String
javaArgs : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
host : String
(optional)
project : String
(optional)
properties : String
(optional)
rtDotnetRun
: run Artifactory .NETapiProtocol : String
(optional)
args : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
project : String
(optional)
resolverId : String
(optional)
rtDownload
: Download artifactsserverId : String
buildName : String
(optional)
buildNumber : String
(optional)
failNoOp : boolean
(optional)
module : String
(optional)
project : String
(optional)
spec : String
(optional)
specPath : String
(optional)
rtGoDeployer
: set go deployerid : String
serverId : String
repo : String
(optional)
customBuildName : String
(optional)
properties : Array / List of String
(optional)
rtGoPublish
: run Artifactory Go publishbuildName : String
(optional)
buildNumber : String
(optional)
deployerId : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
path : String
(optional)
project : String
(optional)
version : String
(optional)
rtGoRun
: run Artifactory Go publishargs : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
path : String
(optional)
project : String
(optional)
resolverId : String
(optional)
rtGradleDeployer
: set gradle deployerid : String
serverId : String
artifactPattern : String
(optional)
customBuildName : String
(optional)
deployIvyDescriptors : boolean
(optional)
deployMavenDescriptors : boolean
(optional)
excludePatterns : Array / List of String
(optional)
includeEnvVars : boolean
(optional)
includePatterns : Array / List of String
(optional)
ivyPattern : String
(optional)
mavenCompatible : boolean
(optional)
properties : Array / List of String
(optional)
publications : Array / List of String
(optional)
releaseRepo : String
(optional)
repo : String
(optional)
snapshotRepo : String
(optional)
threads : int
(optional)
rtGradleRun
: run Artifactory gradlebuildFile : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
deployerId : String
(optional)
project : String
(optional)
resolverId : String
(optional)
rootDir : String
(optional)
switches : String
(optional)
tasks : String
(optional)
tool : String
(optional)
useWrapper : boolean
(optional)
usesPlugin : boolean
(optional)
rtMavenDeployer
: set maven deployerid : String
releaseRepo : String
snapshotRepo : String
serverId : String
customBuildName : String
(optional)
deployArtifacts : boolean
(optional)
deployEvenIfUnstable : boolean
(optional)
excludePatterns : Array / List of String
(optional)
includeEnvVars : boolean
(optional)
includePatterns : Array / List of String
(optional)
properties : Array / List of String
(optional)
threads : int
(optional)
rtMavenResolver
: set maven resolverid : String
releaseRepo : String
snapshotRepo : String
serverId : String
rtMavenRun
: run Artifactory mavenpom : String
goals : String
buildName : String
(optional)
buildNumber : String
(optional)
deployerId : String
(optional)
opts : String
(optional)
project : String
(optional)
resolverId : String
(optional)
tool : String
(optional)
useWrapper : boolean
(optional)
rtNpmCi
: run Artifactory npm ciargs : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
path : String
(optional)
project : String
(optional)
resolverId : String
(optional)
tool : String
(optional)
rtNpmDeployer
: set npm deployerid : String
serverId : String
repo : String
(optional)
customBuildName : String
(optional)
properties : Array / List of String
(optional)
rtNpmInstall
: run Artifactory npm installargs : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
path : String
(optional)
project : String
(optional)
resolverId : String
(optional)
tool : String
(optional)
rtNpmPublish
: run Artifactory npm publishbuildName : String
(optional)
buildNumber : String
(optional)
deployerId : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
path : String
(optional)
project : String
(optional)
tool : String
(optional)
rtNugetRun
: run Artifactory NuGetapiProtocol : String
(optional)
args : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
project : String
(optional)
resolverId : String
(optional)
rtPipInstall
: run Artifactory pip installargs : String
(optional)
buildName : String
(optional)
buildNumber : String
(optional)
envActivation : String
(optional)
javaArgs : String
(optional)
module : String
(optional)
project : String
(optional)
resolverId : String
(optional)
rtPromote
: Promote buildserverId : String
targetRepo : String
buildName : String
(optional)
buildNumber : String
(optional)
comment : String
(optional)
copy : boolean
(optional)
failFast : boolean
(optional)
includeDependencies : boolean
(optional)
project : String
(optional)
sourceRepo : String
(optional)
status : String
(optional)
rtPublishBuildInfo
: Publish build infoserverId : String
buildName : String
(optional)
buildNumber : String
(optional)
project : String
(optional)
rtServer
: Creates new Artifactory serverid : String
bypassProxy : boolean
(optional)
credentialsId : String
(optional)
deploymentThreads : int
(optional)
password : String
(optional)
retry : int
(optional)
timeout : int
(optional)
url : String
(optional)
username : String
(optional)
rtSetProps
: Set propertiesserverId : String
failNoOp : boolean
(optional)
props : String
(optional)
spec : String
(optional)
specPath : String
(optional)
rtUpload
: Upload artifactsserverId : String
buildName : String
(optional)
buildNumber : String
(optional)
failNoOp : boolean
(optional)
module : String
(optional)
project : String
(optional)
spec : String
(optional)
specPath : String
(optional)
runConanCommand
: Run a Conan commandcommand : String
conanHome : String
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
signReleaseBundle
: Sign a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServer
name : String
version : String
spec : String
gpgPassphrase : String
storingRepo : String
updateReleaseBundle
: Update a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServer
name : String
version : String
spec : String
storingRepo : String
signImmediately : boolean
dryRun : boolean
gpgPassphrase : String
releaseNotesPath : String
releaseNotesSyntax : String
description : String
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.