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.

Table of Contents

Artifactory Plugin

View this plugin on the Plugins site

ArtifactoryGradleBuild: run Artifactory gradle

  • gradleBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.GradleBuild
  • rootDir : String
  • buildFile : String
  • tasks : String
  • switches : String
  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo

MavenDescriptorStep: Get Artifactory Maven descriptor

  • pomFile : String
  • version : String
  • versionPerModule
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • failOnSnapshot : boolean
  • dryRun : boolean

addInteractivePromotion: Add interactive promotion

  • promotionConfig
    • Type: class org.jfrog.hudson.pipeline.common.types.PromotionConfig
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
  • displayName : String

artifactoryBuildTrigger: Trigger Artifactory build

  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
  • paths : String
  • spec : String

artifactoryDistributeBuild: Distribute build

  • distributionConfig
    • Type: class org.jfrog.hudson.pipeline.common.types.DistributionConfig
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

artifactoryDownload: Download artifacts

  • spec : String
  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • failNoOp : boolean
  • module : String
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

artifactoryEditProps: Edit properties

  • spec : String
  • props : String
  • failNoOp : boolean
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
  • editType
    • Values: SET, DELETE

artifactoryGoPublish: Run Artifactory Go Publish command

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • goBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.GoBuild
  • path : String
  • version : String
  • args : String
  • module : String
  • javaArgs : String

artifactoryGoRun: Run Artifactory Go command

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • goBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.GoBuild
  • path : String
  • goCmdArgs : String
  • args : String
  • module : String
  • javaArgs : String

artifactoryMavenBuild: run Artifactory maven

  • mavenBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.MavenBuild
  • pom : String
  • goals : String
  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo

artifactoryNpmCi: Run Artifactory npm ci

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • npmBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.NpmBuild
  • javaArgs : String
  • path : String
  • args : String
  • module : String

artifactoryNpmInstall: Run Artifactory npm install

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • npmBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.NpmBuild
  • javaArgs : String
  • path : String
  • args : String
  • module : String

artifactoryNpmPublish: Run Artifactory npm publish

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • npmBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.NpmBuild
  • path : String
  • javaArgs : String
  • args : String
  • module : String

artifactoryNugetRun: Run Artifactory NuGet

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • nugetBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.NugetBuild
  • javaArgs : String
  • args : String
  • module : String

artifactoryPipRun: Run Artifactory pip install

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • pipBuild
    • Type: class org.jfrog.hudson.pipeline.common.types.builds.PipBuild
  • javaArgs : String
  • args : String
  • envActivation : String
  • module : String

artifactoryPromoteBuild: Promote build

  • promotionConfig
    • Type: class org.jfrog.hudson.pipeline.common.types.PromotionConfig
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

artifactoryUpload: Upload artifacts

  • spec : String
  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • failNoOp : boolean
  • module : String
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

buildAppend: Build append

  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • buildName : String
  • buildNumber : String
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

collectEnv: Collect environment variables and system properties

  • env
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.Env

collectIssues: Collect issues from git and add them to a build

  • issues
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.Issues
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
  • config : String

conanAddRemote: Add new repo to Conan config

  • serverUrl : String
  • serverName : String
  • conanHome : String
  • force : boolean
  • verifySSL : boolean

conanAddUser: Add new user to Conan config

  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
  • serverName : String
  • conanHome : String

createDockerBuildStep: Artifactory create Docker build

  • kanikoImageFile : String
  • jibImageFiles : String
  • sourceRepo : String
  • buildInfo
    • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • server
    • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
  • javaArgs : String

createReleaseBundle: Create a release bundle

  • server
    • Type: 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 bundle

  • server
    • Type: 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 artifacts

    • deployer
        Nested Choice of Objects
    • buildInfo
      • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo

    distributeReleaseBundle: Distribute a release bundle

    • server
      • Type: 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 pull

      • image : String
      • host : String
      • sourceRepo : String
      • javaArgs : String
      • buildInfo
        • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
      • server
        • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

      dockerPushStep: Artifactory docker push

      • image : String
      • host : String
      • targetRepo : String
      • buildInfo
        • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
      • properties
        • Type: org.jfrog.build.api.multiMap.Multimap<java.lang.String, java.lang.String>
      • server
        • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer
      • javaArgs : String

      dsCreateReleaseBundle: Create release bundle

      • serverId : 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 bundle

      • serverId : 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 bundle

        • serverId : 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 bundle

          • serverId : String
          • name : String
          • version : String
          • gpgPassphrase : String (optional)
          • storingRepo : String (optional)

          dsUpdateReleaseBundle: Update a release bundle

          • serverId : 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)

          getArtifactoryServer: Get Artifactory server from Jenkins config

          • artifactoryServerID : String

          getJFrogPlatformInstance: Get JFrog Platform instance from Jenkins config

          • instanceId : String

          initConanClient: Create Conan Client

          • client
            • Type: class org.jfrog.hudson.pipeline.common.types.ConanClient

          jfPipelines: Set output resources and report results for JFrog Pipelines

          • outputResources : String (optional)
          • reportStatus : String (optional)

          jfrogInstance: Creates new JFrog instance

          • id : 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 server

          • url : String
          • username : String
          • password : String
          • credentialsId : String

          newBuildInfo: New buildInfo

            newGoBuild: New Artifactory Go

              newGradleBuild: New Artifactory gradle executor

                newJFrogPlatformInstance: Returns new JFrog platform instance

                • url : String
                • artifactoryUrl : String
                • distributionUrl : String
                • username : String
                • password : String
                • credentialsId : String

                newMavenBuild: New Artifactory maven

                  newNpmBuild: New Artifactory npm executor

                    newNugetBuild: New Artifactory NuGet executor

                      newPipBuild: New Artifactory pip executor

                        publishBuildInfo: Publish build Info to Artifactory

                        • buildInfo
                          • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
                        • server
                          • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

                        rtAddInteractivePromotion: Add interactive promotion

                        • serverId : 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 append

                        • serverId : String
                        • appendBuildName : String
                        • appendBuildNumber : String
                        • buildName : String (optional)
                        • buildNumber : String (optional)
                        • project : String (optional)

                        rtBuildInfo: Create build info

                        • asyncBuildRetention : 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)
                                • Type: class java.util.Date

                              rtBuildTrigger: Trigger Artifactory build

                              • serverId : String
                              • paths : String
                              • spec : String

                              rtCollectIssues: Collect issues

                              • serverId : String
                              • buildName : String (optional)
                              • buildNumber : String (optional)
                              • config : String (optional)
                              • configPath : String (optional)
                              • project : String (optional)

                              rtConanClient: Creates new Conan client

                              • id : String
                              • userHome : String (optional)

                              rtConanRemote: Add new repo to Conan config

                              • clientId : String
                              • name : String
                              • serverId : String
                              • repo : String
                              • force : boolean (optional)
                              • verifySSL : boolean (optional)

                              rtConanRun: Run a Conan command

                              • clientId : String
                              • command : String
                              • buildName : String (optional)
                              • buildNumber : String (optional)
                              • project : String (optional)

                              rtCreateDockerBuild: run Artifactory create Docker build

                              • serverId : String
                              • sourceRepo : String
                              • buildName : String (optional)
                              • buildNumber : String (optional)
                              • javaArgs : String (optional)
                              • jibImageFiles : String (optional)
                              • kanikoImageFile : String (optional)
                              • project : String (optional)

                              rtDeleteProps: Delete properties

                              • serverId : String
                              • failNoOp : boolean (optional)
                              • props : String (optional)
                              • spec : String (optional)
                              • specPath : String (optional)

                              rtDockerPull: run Artifactory docker pull

                              • serverId : String
                              • image : String
                              • sourceRepo : String
                              • buildName : String (optional)
                              • buildNumber : String (optional)
                              • host : String (optional)
                              • javaArgs : String (optional)
                              • project : String (optional)

                              rtDockerPush: run Artifactory docker push

                              • serverId : String
                              • image : String
                              • targetRepo : String
                              • javaArgs : String (optional)
                              • buildName : String (optional)
                              • buildNumber : String (optional)
                              • host : String (optional)
                              • project : String (optional)
                              • properties : String (optional)

                              rtDotnetResolver: set .NET resolver

                              • id : String
                              • serverId : String
                              • repo : String (optional)

                              rtDotnetRun: run Artifactory .NET

                              • apiProtocol : 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 artifacts

                              • serverId : 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 deployer

                              • id : String
                              • serverId : String
                              • repo : String (optional)
                              • customBuildName : String (optional)
                              • properties : Array / List of String (optional)

                                rtGoPublish: run Artifactory Go publish

                                • buildName : String (optional)
                                • buildNumber : String (optional)
                                • deployerId : String (optional)
                                • javaArgs : String (optional)
                                • module : String (optional)
                                • path : String (optional)
                                • project : String (optional)
                                • version : String (optional)

                                rtGoResolver: set Go resolver

                                • id : String
                                • serverId : String
                                • repo : String (optional)

                                rtGoRun: run Artifactory Go publish

                                • args : 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 deployer

                                • id : 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)

                                        rtGradleResolver: set gradle resolver

                                        • id : String
                                        • serverId : String
                                        • repo : String (optional)

                                        rtGradleRun: run Artifactory gradle

                                        • buildFile : 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 deployer

                                        • id : 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 resolver

                                              • id : String
                                              • releaseRepo : String
                                              • snapshotRepo : String
                                              • serverId : String

                                              rtMavenRun: run Artifactory maven

                                              • pom : 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 ci

                                              • args : 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 deployer

                                              • id : String
                                              • serverId : String
                                              • repo : String (optional)
                                              • customBuildName : String (optional)
                                              • properties : Array / List of String (optional)

                                                rtNpmInstall: run Artifactory npm install

                                                • args : 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 publish

                                                • buildName : String (optional)
                                                • buildNumber : String (optional)
                                                • deployerId : String (optional)
                                                • javaArgs : String (optional)
                                                • module : String (optional)
                                                • path : String (optional)
                                                • project : String (optional)
                                                • tool : String (optional)

                                                rtNpmResolver: set npm resolver

                                                • id : String
                                                • serverId : String
                                                • repo : String (optional)

                                                rtNugetResolver: set NuGet resolver

                                                • id : String
                                                • serverId : String
                                                • repo : String (optional)

                                                rtNugetRun: run Artifactory NuGet

                                                • apiProtocol : 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 install

                                                • args : String (optional)
                                                • buildName : String (optional)
                                                • buildNumber : String (optional)
                                                • envActivation : String (optional)
                                                • javaArgs : String (optional)
                                                • module : String (optional)
                                                • project : String (optional)
                                                • resolverId : String (optional)

                                                rtPipResolver: set pip resolver

                                                • id : String
                                                • serverId : String
                                                • repo : String (optional)

                                                rtPromote: Promote build

                                                • serverId : 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 info

                                                • serverId : String
                                                • buildName : String (optional)
                                                • buildNumber : String (optional)
                                                • project : String (optional)

                                                rtServer: Creates new Artifactory server

                                                • id : 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 properties

                                                • serverId : String
                                                • failNoOp : boolean (optional)
                                                • props : String (optional)
                                                • spec : String (optional)
                                                • specPath : String (optional)

                                                rtUpload: Upload artifacts

                                                • serverId : 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 command

                                                • command : String
                                                • conanHome : String
                                                • buildInfo
                                                  • Type: class org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo

                                                signReleaseBundle: Sign a release bundle

                                                • server
                                                  • Type: class org.jfrog.hudson.pipeline.common.types.DistributionServer
                                                • name : String
                                                • version : String
                                                • spec : String
                                                • gpgPassphrase : String
                                                • storingRepo : String

                                                updateReleaseBundle: Update a release bundle

                                                • server
                                                  • Type: 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

                                                xrayScan: run Xray scan

                                                • serverId : String
                                                • buildName : String (optional)
                                                • buildNumber : String (optional)
                                                • failBuild : boolean (optional)
                                                • printTable : boolean (optional)
                                                • project : String (optional)

                                                xrayScanBuild: Xray build scanning

                                                • xrayScanConfig
                                                  • Type: class org.jfrog.hudson.pipeline.common.types.XrayScanConfig
                                                • server
                                                  • Type: class org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

                                                Was this page helpful?

                                                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.