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
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
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
(optional)
String
dryRun
(optional)
boolean
gpgPassphrase
(optional)
String
releaseNotesPath
(optional)
String
releaseNotesSyntax
(optional)
String
signImmediately
(optional)
boolean
specPath
(optional)
String
storingRepo
(optional)
String
dsDeleteReleaseBundle
: Delete a release bundleserverId
String
name
String
version
String
cityName
(optional)
String
countryCodes
(optional)
String
deleteFromDist
(optional)
boolean
distRules
(optional)
String
dryRun
(optional)
boolean
siteName
(optional)
String
sync
(optional)
boolean
dsDistributeReleaseBundle
: Distribute a release bundleserverId
String
name
String
version
String
cityName
(optional)
String
countryCodes
(optional)
String
distRules
(optional)
String
dryRun
(optional)
boolean
siteName
(optional)
String
sync
(optional)
boolean
dsSignReleaseBundle
: Sign a release bundleserverId
String
name
String
version
String
gpgPassphrase
(optional)
String
storingRepo
(optional)
String
dsUpdateReleaseBundle
: Update a release bundleserverId
String
name
String
version
String
spec
String
description
(optional)
String
dryRun
(optional)
boolean
gpgPassphrase
(optional)
String
releaseNotesPath
(optional)
String
releaseNotesSyntax
(optional)
String
signImmediately
(optional)
boolean
specPath
(optional)
String
storingRepo
(optional)
String
initConanClient
: Create Conan Clientclient
class org.jfrog.hudson.pipeline.common.types.ConanClient
jfPipelines
: Set output resources and report results for JFrog PipelinesoutputResources
(optional)
String
reportStatus
(optional)
String
jfrogInstance
: Creates new JFrog instanceid
String
artifactoryUrl
(optional)
String
bypassProxy
(optional)
boolean
credentialsId
(optional)
String
deploymentThreads
(optional)
int
distributionUrl
(optional)
String
password
(optional)
String
retry
(optional)
int
timeout
(optional)
int
url
(optional)
String
username
(optional)
String
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
(optional)
String
buildNumber
(optional)
String
comment
(optional)
String
copy
(optional)
boolean
displayName
(optional)
String
failFast
(optional)
boolean
includeDependencies
(optional)
boolean
project
(optional)
String
sourceRepo
(optional)
String
status
(optional)
String
targetRepo
(optional)
String
rtBuildAppend
: Build appendserverId
String
appendBuildName
String
appendBuildNumber
String
buildName
(optional)
String
buildNumber
(optional)
String
project
(optional)
String
rtBuildInfo
: Create build infoasyncBuildRetention
(optional)
boolean
buildName
(optional)
String
buildNumber
(optional)
String
captureEnv
(optional)
boolean
deleteBuildArtifacts
(optional)
boolean
doNotDiscardBuilds
(optional)
String
excludeEnvPatterns
(optional)
String
includeEnvPatterns
(optional)
String
maxBuilds
(optional)
int
maxDays
(optional)
int
project
(optional)
String
startDate
(optional)
class java.util.Date
rtBuildTrigger
: Trigger Artifactory buildserverId
String
paths
String
spec
String
rtCollectIssues
: Collect issuesserverId
String
buildName
(optional)
String
buildNumber
(optional)
String
config
(optional)
String
configPath
(optional)
String
project
(optional)
String
rtConanRemote
: Add new repo to Conan configclientId
String
name
String
serverId
String
repo
String
force
(optional)
boolean
verifySSL
(optional)
boolean
rtConanRun
: Run a Conan commandclientId
String
command
String
buildName
(optional)
String
buildNumber
(optional)
String
project
(optional)
String
rtCreateDockerBuild
: run Artifactory create Docker buildserverId
String
sourceRepo
String
buildName
(optional)
String
buildNumber
(optional)
String
javaArgs
(optional)
String
jibImageFiles
(optional)
String
kanikoImageFile
(optional)
String
project
(optional)
String
rtDeleteProps
: Delete propertiesserverId
String
failNoOp
(optional)
boolean
props
(optional)
String
spec
(optional)
String
specPath
(optional)
String
rtDockerPull
: run Artifactory docker pullserverId
String
image
String
sourceRepo
String
buildName
(optional)
String
buildNumber
(optional)
String
host
(optional)
String
javaArgs
(optional)
String
project
(optional)
String
rtDockerPush
: run Artifactory docker pushserverId
String
image
String
targetRepo
String
javaArgs
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
host
(optional)
String
project
(optional)
String
properties
(optional)
String
rtDotnetResolver
: set .NET resolverid
String
serverId
String
repo
(optional)
String
rtDotnetRun
: run Artifactory .NETapiProtocol
(optional)
String
args
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
project
(optional)
String
resolverId
(optional)
String
rtDownload
: Download artifactsserverId
String
buildName
(optional)
String
buildNumber
(optional)
String
failNoOp
(optional)
boolean
module
(optional)
String
project
(optional)
String
spec
(optional)
String
specPath
(optional)
String
rtGoDeployer
: set go deployerid
String
serverId
String
repo
(optional)
String
customBuildName
(optional)
String
properties
(optional)
String
rtGoPublish
: run Artifactory Go publishbuildName
(optional)
String
buildNumber
(optional)
String
deployerId
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
path
(optional)
String
project
(optional)
String
version
(optional)
String
rtGoRun
: run Artifactory Go publishargs
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
path
(optional)
String
project
(optional)
String
resolverId
(optional)
String
rtGradleDeployer
: set gradle deployerid
String
serverId
String
artifactPattern
(optional)
String
customBuildName
(optional)
String
deployIvyDescriptors
(optional)
boolean
deployMavenDescriptors
(optional)
boolean
excludePatterns
(optional)
String
includeEnvVars
(optional)
boolean
includePatterns
(optional)
String
ivyPattern
(optional)
String
mavenCompatible
(optional)
boolean
properties
(optional)
String
publications
(optional)
String
releaseRepo
(optional)
String
repo
(optional)
String
snapshotRepo
(optional)
String
threads
(optional)
int
rtGradleResolver
: set gradle resolverid
String
serverId
String
repo
(optional)
String
rtGradleRun
: run Artifactory gradlebuildFile
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
deployerId
(optional)
String
project
(optional)
String
resolverId
(optional)
String
rootDir
(optional)
String
switches
(optional)
String
tasks
(optional)
String
tool
(optional)
String
useWrapper
(optional)
boolean
usesPlugin
(optional)
boolean
rtMavenDeployer
: set maven deployerid
String
releaseRepo
String
snapshotRepo
String
serverId
String
customBuildName
(optional)
String
deployArtifacts
(optional)
boolean
deployEvenIfUnstable
(optional)
boolean
excludePatterns
(optional)
String
includeEnvVars
(optional)
boolean
includePatterns
(optional)
String
properties
(optional)
String
threads
(optional)
int
rtMavenResolver
: set maven resolverid
String
releaseRepo
String
snapshotRepo
String
serverId
String
rtMavenRun
: run Artifactory mavenpom
String
goals
String
buildName
(optional)
String
buildNumber
(optional)
String
deployerId
(optional)
String
opts
(optional)
String
project
(optional)
String
resolverId
(optional)
String
tool
(optional)
String
useWrapper
(optional)
boolean
rtNpmCi
: run Artifactory npm ciargs
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
path
(optional)
String
project
(optional)
String
resolverId
(optional)
String
tool
(optional)
String
rtNpmDeployer
: set npm deployerid
String
serverId
String
repo
(optional)
String
customBuildName
(optional)
String
properties
(optional)
String
rtNpmInstall
: run Artifactory npm installargs
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
path
(optional)
String
project
(optional)
String
resolverId
(optional)
String
tool
(optional)
String
rtNpmPublish
: run Artifactory npm publishbuildName
(optional)
String
buildNumber
(optional)
String
deployerId
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
path
(optional)
String
project
(optional)
String
tool
(optional)
String
rtNugetResolver
: set NuGet resolverid
String
serverId
String
repo
(optional)
String
rtNugetRun
: run Artifactory NuGetapiProtocol
(optional)
String
args
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
project
(optional)
String
resolverId
(optional)
String
rtPipInstall
: run Artifactory pip installargs
(optional)
String
buildName
(optional)
String
buildNumber
(optional)
String
envActivation
(optional)
String
javaArgs
(optional)
String
module
(optional)
String
project
(optional)
String
resolverId
(optional)
String
rtPromote
: Promote buildserverId
String
targetRepo
String
buildName
(optional)
String
buildNumber
(optional)
String
comment
(optional)
String
copy
(optional)
boolean
failFast
(optional)
boolean
includeDependencies
(optional)
boolean
project
(optional)
String
sourceRepo
(optional)
String
status
(optional)
String
rtPublishBuildInfo
: Publish build infoserverId
String
buildName
(optional)
String
buildNumber
(optional)
String
project
(optional)
String
rtServer
: Creates new Artifactory serverid
String
bypassProxy
(optional)
boolean
credentialsId
(optional)
String
deploymentThreads
(optional)
int
password
(optional)
String
retry
(optional)
int
timeout
(optional)
int
url
(optional)
String
username
(optional)
String
rtSetProps
: Set propertiesserverId
String
failNoOp
(optional)
boolean
props
(optional)
String
spec
(optional)
String
specPath
(optional)
String
rtUpload
: Upload artifactsserverId
String
buildName
(optional)
String
buildNumber
(optional)
String
failNoOp
(optional)
boolean
module
(optional)
String
project
(optional)
String
spec
(optional)
String
specPath
(optional)
String
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.