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.GradleBuildrootDir
StringbuildFile
Stringtasks
Stringswitches
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfoMavenDescriptorStep: Get Artifactory Maven descriptorpomFile
Stringversion
StringversionPerModule
java.util.Map<java.lang.String, java.lang.String>failOnSnapshot
booleandryRun
booleanaddInteractivePromotion: Add interactive promotionpromotionConfig
class org.jfrog.hudson.pipeline.common.types.PromotionConfigserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerdisplayName
StringartifactoryBuildTrigger: Trigger Artifactory buildserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerpaths
Stringspec
StringartifactoryDistributeBuild: Distribute builddistributionConfig
class org.jfrog.hudson.pipeline.common.types.DistributionConfigserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerartifactoryDownload: Download artifactsspec
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfofailNoOp
booleanmodule
Stringserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerartifactoryEditProps: Edit propertiesspec
Stringprops
StringfailNoOp
booleanserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServereditType
SET, DELETEartifactoryGoPublish: Run Artifactory Go Publish commandbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfogoBuild
class org.jfrog.hudson.pipeline.common.types.builds.GoBuildpath
Stringversion
Stringargs
Stringmodule
StringjavaArgs
StringartifactoryGoRun: Run Artifactory Go commandbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfogoBuild
class org.jfrog.hudson.pipeline.common.types.builds.GoBuildpath
StringgoCmdArgs
Stringargs
Stringmodule
StringjavaArgs
StringartifactoryMavenBuild: run Artifactory mavenmavenBuild
class org.jfrog.hudson.pipeline.common.types.builds.MavenBuildpom
Stringgoals
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfoartifactoryNpmCi: Run Artifactory npm cibuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfonpmBuild
class org.jfrog.hudson.pipeline.common.types.builds.NpmBuildjavaArgs
Stringpath
Stringargs
Stringmodule
StringartifactoryNpmInstall: Run Artifactory npm installbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfonpmBuild
class org.jfrog.hudson.pipeline.common.types.builds.NpmBuildjavaArgs
Stringpath
Stringargs
Stringmodule
StringartifactoryNpmPublish: Run Artifactory npm publishbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfonpmBuild
class org.jfrog.hudson.pipeline.common.types.builds.NpmBuildpath
StringjavaArgs
Stringargs
Stringmodule
StringartifactoryNugetRun: Run Artifactory NuGetbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfonugetBuild
class org.jfrog.hudson.pipeline.common.types.builds.NugetBuildjavaArgs
Stringargs
Stringmodule
StringartifactoryPipRun: Run Artifactory pip installbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfopipBuild
class org.jfrog.hudson.pipeline.common.types.builds.PipBuildjavaArgs
Stringargs
StringenvActivation
Stringmodule
StringartifactoryPromoteBuild: Promote buildpromotionConfig
class org.jfrog.hudson.pipeline.common.types.PromotionConfigserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerartifactoryUpload: Upload artifactsspec
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfofailNoOp
booleanmodule
Stringserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerbuildAppend: Build appendbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfobuildName
StringbuildNumber
Stringserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServercollectEnv: Collect environment variables and system propertiesenv
class org.jfrog.hudson.pipeline.common.types.buildInfo.EnvcollectIssues: Collect issues from git and add them to a buildissues
class org.jfrog.hudson.pipeline.common.types.buildInfo.Issuesserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerconfig
StringconanAddRemote: Add new repo to Conan configserverUrl
StringserverName
StringconanHome
Stringforce
booleanverifySSL
booleanconanAddUser: Add new user to Conan configserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerserverName
StringconanHome
StringcreateDockerBuildStep: Artifactory create Docker buildkanikoImageFile
StringjibImageFiles
StringsourceRepo
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfoserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerjavaArgs
StringcreateReleaseBundle: Create a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServername
Stringversion
Stringspec
StringstoringRepo
StringsignImmediately
booleandryRun
booleangpgPassphrase
StringreleaseNotesPath
StringreleaseNotesSyntax
Stringdescription
StringdeleteReleaseBundle: Delete a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServername
Stringversion
StringdryRun
booleansync
booleandeleteFromDist
booleandistRules
StringcountryCodes
StringsiteName
StringcityName
StringdeployArtifacts: Deploy artifactsdeployer
buildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfodistributeReleaseBundle: Distribute a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServername
Stringversion
StringdryRun
booleansync
booleandistRules
StringcountryCodes
StringsiteName
StringcityName
StringdockerPullStep: Artifactory docker pullimage
Stringhost
StringsourceRepo
StringjavaArgs
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfoserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerdockerPushStep: Artifactory docker pushimage
Stringhost
StringtargetRepo
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfoproperties
com.google.common.collect.ArrayListMultimap<java.lang.String, java.lang.String>server
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerjavaArgs
StringdsCreateReleaseBundle: Create release bundleserverId
Stringname
Stringversion
Stringspec
Stringdescription (optional)
StringdryRun (optional)
booleangpgPassphrase (optional)
StringreleaseNotesPath (optional)
StringreleaseNotesSyntax (optional)
StringsignImmediately (optional)
booleanspecPath (optional)
StringstoringRepo (optional)
StringdsDeleteReleaseBundle: Delete a release bundleserverId
Stringname
Stringversion
StringcityName (optional)
StringcountryCodes (optional)
StringdeleteFromDist (optional)
booleandistRules (optional)
StringdryRun (optional)
booleansiteName (optional)
Stringsync (optional)
booleandsDistributeReleaseBundle: Distribute a release bundleserverId
Stringname
Stringversion
StringcityName (optional)
StringcountryCodes (optional)
StringdistRules (optional)
StringdryRun (optional)
booleansiteName (optional)
Stringsync (optional)
booleandsSignReleaseBundle: Sign a release bundleserverId
Stringname
Stringversion
StringgpgPassphrase (optional)
StringstoringRepo (optional)
StringdsUpdateReleaseBundle: Update a release bundleserverId
Stringname
Stringversion
Stringspec
Stringdescription (optional)
StringdryRun (optional)
booleangpgPassphrase (optional)
StringreleaseNotesPath (optional)
StringreleaseNotesSyntax (optional)
StringsignImmediately (optional)
booleanspecPath (optional)
StringstoringRepo (optional)
StringinitConanClient: Create Conan Clientclient
class org.jfrog.hudson.pipeline.common.types.ConanClientjfPipelines: Set output resources and report results for JFrog PipelinesoutputResources (optional)
StringreportStatus (optional)
StringjfrogInstance: Creates new JFrog instanceid
StringartifactoryUrl (optional)
StringbypassProxy (optional)
booleancredentialsId (optional)
StringdeploymentThreads (optional)
intdistributionUrl (optional)
Stringpassword (optional)
Stringretry (optional)
inttimeout (optional)
inturl (optional)
Stringusername (optional)
StringnewArtifactoryServer: Returns new Artifactory serverurl
Stringusername
Stringpassword
StringcredentialsId
StringnewJFrogPlatformInstance: Returns new JFrog platform instanceurl
StringartifactoryUrl
StringdistributionUrl
Stringusername
Stringpassword
StringcredentialsId
StringpublishBuildInfo: Publish build Info to ArtifactorybuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfoserver
class org.jfrog.hudson.pipeline.common.types.ArtifactoryServerrtAddInteractivePromotion: Add interactive promotionserverId
StringbuildName (optional)
StringbuildNumber (optional)
Stringcomment (optional)
Stringcopy (optional)
booleandisplayName (optional)
StringfailFast (optional)
booleanincludeDependencies (optional)
booleanproject (optional)
StringsourceRepo (optional)
Stringstatus (optional)
StringtargetRepo (optional)
StringrtBuildAppend: Build appendserverId
StringappendBuildName
StringappendBuildNumber
StringbuildName (optional)
StringbuildNumber (optional)
StringrtBuildInfo: Create build infoasyncBuildRetention (optional)
booleanbuildName (optional)
StringbuildNumber (optional)
StringcaptureEnv (optional)
booleandeleteBuildArtifacts (optional)
booleandoNotDiscardBuilds (optional)
StringexcludeEnvPatterns (optional)
StringincludeEnvPatterns (optional)
StringmaxBuilds (optional)
intmaxDays (optional)
intproject (optional)
StringstartDate (optional)
class java.util.DatertBuildTrigger: Trigger Artifactory buildserverId
Stringpaths
Stringspec
StringrtCollectIssues: Collect issuesserverId
StringbuildName (optional)
StringbuildNumber (optional)
Stringconfig (optional)
StringconfigPath (optional)
Stringproject (optional)
StringrtConanRemote: Add new repo to Conan configclientId
Stringname
StringserverId
Stringrepo
Stringforce (optional)
booleanverifySSL (optional)
booleanrtConanRun: Run a Conan commandclientId
Stringcommand
StringbuildName (optional)
StringbuildNumber (optional)
Stringproject (optional)
StringrtCreateDockerBuild: run Artifactory create Docker buildserverId
StringsourceRepo
StringbuildName (optional)
StringbuildNumber (optional)
StringjavaArgs (optional)
StringjibImageFiles (optional)
StringkanikoImageFile (optional)
Stringproject (optional)
StringrtDeleteProps: Delete propertiesserverId
StringfailNoOp (optional)
booleanprops (optional)
Stringspec (optional)
StringspecPath (optional)
StringrtDockerPull: run Artifactory docker pullserverId
Stringimage
StringsourceRepo
StringbuildName (optional)
StringbuildNumber (optional)
Stringhost (optional)
StringjavaArgs (optional)
Stringproject (optional)
StringrtDockerPush: run Artifactory docker pushserverId
Stringimage
StringtargetRepo
StringjavaArgs (optional)
StringbuildName (optional)
StringbuildNumber (optional)
Stringhost (optional)
Stringproject (optional)
Stringproperties (optional)
StringrtDotnetResolver: set .NET resolverid
StringserverId
Stringrepo (optional)
StringrtDotnetRun: run Artifactory .NETapiProtocol (optional)
Stringargs (optional)
StringbuildName (optional)
StringbuildNumber (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringproject (optional)
StringresolverId (optional)
StringrtDownload: Download artifactsserverId
StringbuildName (optional)
StringbuildNumber (optional)
StringfailNoOp (optional)
booleanmodule (optional)
Stringproject (optional)
Stringspec (optional)
StringspecPath (optional)
StringrtGoDeployer: set go deployerid
StringserverId
Stringrepo (optional)
StringcustomBuildName (optional)
Stringproperties (optional)
StringrtGoPublish: run Artifactory Go publishbuildName (optional)
StringbuildNumber (optional)
StringdeployerId (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringpath (optional)
Stringproject (optional)
Stringversion (optional)
StringrtGoRun: run Artifactory Go publishargs (optional)
StringbuildName (optional)
StringbuildNumber (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringpath (optional)
Stringproject (optional)
StringresolverId (optional)
StringrtGradleDeployer: set gradle deployerid
StringserverId
StringartifactPattern (optional)
StringcustomBuildName (optional)
StringdeployIvyDescriptors (optional)
booleandeployMavenDescriptors (optional)
booleanexcludePatterns (optional)
StringincludeEnvVars (optional)
booleanincludePatterns (optional)
StringivyPattern (optional)
StringmavenCompatible (optional)
booleanproperties (optional)
Stringpublications (optional)
StringreleaseRepo (optional)
Stringrepo (optional)
StringsnapshotRepo (optional)
Stringthreads (optional)
intrtGradleResolver: set gradle resolverid
StringserverId
Stringrepo (optional)
StringrtGradleRun: run Artifactory gradlebuildFile (optional)
StringbuildName (optional)
StringbuildNumber (optional)
StringdeployerId (optional)
Stringproject (optional)
StringresolverId (optional)
StringrootDir (optional)
Stringswitches (optional)
Stringtasks (optional)
Stringtool (optional)
StringuseWrapper (optional)
booleanusesPlugin (optional)
booleanrtMavenDeployer: set maven deployerid
StringreleaseRepo
StringsnapshotRepo
StringserverId
StringcustomBuildName (optional)
StringdeployArtifacts (optional)
booleandeployEvenIfUnstable (optional)
booleanexcludePatterns (optional)
StringincludeEnvVars (optional)
booleanincludePatterns (optional)
Stringproperties (optional)
Stringthreads (optional)
intrtMavenResolver: set maven resolverid
StringreleaseRepo
StringsnapshotRepo
StringserverId
StringrtMavenRun: run Artifactory mavenpom
Stringgoals
StringbuildName (optional)
StringbuildNumber (optional)
StringdeployerId (optional)
Stringopts (optional)
Stringproject (optional)
StringresolverId (optional)
Stringtool (optional)
StringuseWrapper (optional)
booleanrtNpmCi: run Artifactory npm ciargs (optional)
StringbuildName (optional)
StringbuildNumber (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringpath (optional)
Stringproject (optional)
StringresolverId (optional)
Stringtool (optional)
StringrtNpmDeployer: set npm deployerid
StringserverId
Stringrepo (optional)
StringcustomBuildName (optional)
Stringproperties (optional)
StringrtNpmInstall: run Artifactory npm installargs (optional)
StringbuildName (optional)
StringbuildNumber (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringpath (optional)
Stringproject (optional)
StringresolverId (optional)
Stringtool (optional)
StringrtNpmPublish: run Artifactory npm publishbuildName (optional)
StringbuildNumber (optional)
StringdeployerId (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringpath (optional)
Stringproject (optional)
Stringtool (optional)
StringrtNugetResolver: set NuGet resolverid
StringserverId
Stringrepo (optional)
StringrtNugetRun: run Artifactory NuGetapiProtocol (optional)
Stringargs (optional)
StringbuildName (optional)
StringbuildNumber (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringproject (optional)
StringresolverId (optional)
StringrtPipInstall: run Artifactory pip installargs (optional)
StringbuildName (optional)
StringbuildNumber (optional)
StringenvActivation (optional)
StringjavaArgs (optional)
Stringmodule (optional)
Stringproject (optional)
StringresolverId (optional)
StringrtPromote: Promote buildserverId
StringtargetRepo
StringbuildName (optional)
StringbuildNumber (optional)
Stringcomment (optional)
Stringcopy (optional)
booleanfailFast (optional)
booleanincludeDependencies (optional)
booleanproject (optional)
StringsourceRepo (optional)
Stringstatus (optional)
StringrtPublishBuildInfo: Publish build infoserverId
StringbuildName (optional)
StringbuildNumber (optional)
Stringproject (optional)
StringrtServer: Creates new Artifactory serverid
StringbypassProxy (optional)
booleancredentialsId (optional)
StringdeploymentThreads (optional)
intpassword (optional)
Stringretry (optional)
inttimeout (optional)
inturl (optional)
Stringusername (optional)
StringrtSetProps: Set propertiesserverId
StringfailNoOp (optional)
booleanprops (optional)
Stringspec (optional)
StringspecPath (optional)
StringrtUpload: Upload artifactsserverId
StringbuildName (optional)
StringbuildNumber (optional)
StringfailNoOp (optional)
booleanmodule (optional)
Stringproject (optional)
Stringspec (optional)
StringspecPath (optional)
StringrunConanCommand: Run a Conan commandcommand
StringconanHome
StringbuildInfo
class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfosignReleaseBundle: Sign a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServername
Stringversion
Stringspec
StringgpgPassphrase
StringstoringRepo
StringupdateReleaseBundle: Update a release bundleserver
class org.jfrog.hudson.pipeline.common.types.DistributionServername
Stringversion
Stringspec
StringstoringRepo
StringsignImmediately
booleandryRun
booleangpgPassphrase
StringreleaseNotesPath
StringreleaseNotesSyntax
Stringdescription
StringPlease 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.