Jenkins User Documentation Home

Guided Tour

Tutorials

Handbook

Resources

Tutorial Blog Posts
View all tutorial blog posts

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
      org.jfrog.hudson.pipeline.common.types.builds.GradleBuild
  • rootDir
    • Type: String
  • buildFile
    • Type: String
  • tasks
    • Type: String
  • switches
    • Type: String
  • buildInfo
      org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo

MavenDescriptorStep: Get Artifactory Maven descriptor

  • pomFile
    • Type: String
  • version
    • Type: String
  • versionPerModule
      java.lang.String>
  • failOnSnapshot
    • Type: boolean
  • dryRun
    • Type: boolean

addInteractivePromotion: Add interactive promotion

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

artifactoryDistributeBuild: Distribute build

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

artifactoryDownload: Download artifacts

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

artifactoryEditProps: Edit properties

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

artifactoryGoPublish: Run Artifactory Go Publish command

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

artifactoryGoRun: Run Artifactory Go command

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

artifactoryMavenBuild: run Artifactory maven

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

artifactoryNpmInstall: Run Artifactory npm install

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

artifactoryNpmPublish: Run Artifactory npm publish

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

artifactoryPromoteBuild: Promote build

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

artifactoryUpload: Upload artifacts

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

collectEnv: Collect environment variables and system properties

  • env
      org.jfrog.hudson.pipeline.common.types.buildInfo.Env

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

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

conanAddRemote: Add new repo to Conan config

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

conanAddUser: Add new user to Conan config

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

deployArtifacts: Deploy artifacts

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

dockerPullStep: Artifactory docker pull

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

dockerPushStep: Artifactory docker push

  • image
    • Type: String
  • host
    • Type: String
  • targetRepo
    • Type: String
  • buildInfo
      org.jfrog.hudson.pipeline.common.types.buildInfo.BuildInfo
  • properties
      java.lang.String>
  • server
      org.jfrog.hudson.pipeline.common.types.ArtifactoryServer

getArtifactoryServer: Get Artifactory server from Jenkins config

  • artifactoryServerID
    • Type: String

initConanClient: Create Conan Client

  • client
      org.jfrog.hudson.pipeline.common.types.ConanClient

newArtifactoryServer: Returns new Artifactory server

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

newBuildInfo: New buildInfo

    newGoBuild: New Artifactory Go

      newGradleBuild: New Artifactory gradle executor

        newMavenBuild: New Artifactory maven

          newNpmBuild: New Artifactory npm executor

            publishBuildInfo: Publish build Info to Artifactory

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

            rtAddInteractivePromotion: Add interactive promotion

            • serverId
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • comment (optional)
              • Type: String
            • copy (optional)
              • Type: boolean
            • displayName (optional)
              • Type: String
            • failFast (optional)
              • Type: boolean
            • includeDependencies (optional)
              • Type: boolean
            • sourceRepo (optional)
              • Type: String
            • status (optional)
              • Type: String
            • targetRepo (optional)
              • Type: String

            rtBuildInfo: Create build info

            • asyncBuildRetention (optional)
              • Type: boolean
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • captureEnv (optional)
              • Type: boolean
            • deleteBuildArtifacts (optional)
              • Type: boolean
            • doNotDiscardBuilds (optional)
                Array/List
              • Type: String
            • excludeEnvPatterns (optional)
                Array/List
              • Type: String
            • includeEnvPatterns (optional)
                Array/List
              • Type: String
            • maxBuilds (optional)
              • Type: int
            • maxDays (optional)
              • Type: int
            • startDate (optional)
                java.util.Date

            rtCollectIssues: Collect issues

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

            rtDeleteProps: Delete properties

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

            rtDockerPush: run Artifactory docker push

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

            rtDownload: Download artifacts

            • serverId
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • failNoOp (optional)
              • Type: boolean
            • module (optional)
              • Type: String
            • spec (optional)
              • Type: String
            • specPath (optional)
              • Type: String

            rtGoDeployer: set go deployer

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

            rtGoPublish: run Artifactory Go publish

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

            rtGoResolver: set Go resolver

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

            rtGoRun: run Artifactory Go publish

            • args (optional)
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • module (optional)
              • Type: String
            • path (optional)
              • Type: String
            • resolverId (optional)
              • Type: String

            rtGradleDeployer: set gradle deployer

            • id
              • Type: String
            • serverId
              • Type: String
            • artifactPattern (optional)
              • Type: String
            • customBuildName (optional)
              • Type: String
            • deployIvyDescriptors (optional)
              • Type: boolean
            • deployMavenDescriptors (optional)
              • Type: boolean
            • excludePatterns (optional)
                Array/List
              • Type: String
            • includeEnvVars (optional)
              • Type: boolean
            • includePatterns (optional)
                Array/List
              • Type: String
            • ivyPattern (optional)
              • Type: String
            • mavenCompatible (optional)
              • Type: boolean
            • properties (optional)
                Array/List
              • Type: String
            • releaseRepo (optional)
              • Type: String
            • repo (optional)
              • Type: String
            • snapshotRepo (optional)
              • Type: String
            • threads (optional)
              • Type: int

            rtGradleResolver: set gradle resolver

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

            rtGradleRun: run Artifactory gradle

            • buildFile (optional)
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • deployerId (optional)
              • Type: String
            • resolverId (optional)
              • Type: String
            • rootDir (optional)
              • Type: String
            • switches (optional)
              • Type: String
            • tasks (optional)
              • Type: String
            • tool (optional)
              • Type: String
            • useWrapper (optional)
              • Type: boolean
            • usesPlugin (optional)
              • Type: boolean

            rtMavenDeployer: set maven deployer

            • id
              • Type: String
            • releaseRepo
              • Type: String
            • snapshotRepo
              • Type: String
            • serverId
              • Type: String
            • customBuildName (optional)
              • Type: String
            • deployArtifacts (optional)
              • Type: boolean
            • deployEvenIfUnstable (optional)
              • Type: boolean
            • excludePatterns (optional)
                Array/List
              • Type: String
            • includeEnvVars (optional)
              • Type: boolean
            • includePatterns (optional)
                Array/List
              • Type: String
            • properties (optional)
                Array/List
              • Type: String
            • threads (optional)
              • Type: int

            rtMavenResolver: set maven resolver

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

            rtMavenRun: run Artifactory maven

            • pom
              • Type: String
            • goals
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • deployerId (optional)
              • Type: String
            • opts (optional)
              • Type: String
            • resolverId (optional)
              • Type: String
            • tool (optional)
              • Type: String

            rtNpmDeployer: set npm deployer

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

            rtNpmInstall: run Artifactory npm install

            • args (optional)
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • javaArgs (optional)
              • Type: String
            • module (optional)
              • Type: String
            • path (optional)
              • Type: String
            • resolverId (optional)
              • Type: String
            • tool (optional)
              • Type: String

            rtNpmPublish: run Artifactory npm publish

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

            rtNpmResolver: set npm resolver

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

            rtPromote: Promote build

            • serverId
              • Type: String
            • targetRepo
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • comment (optional)
              • Type: String
            • copy (optional)
              • Type: boolean
            • failFast (optional)
              • Type: boolean
            • includeDependencies (optional)
              • Type: boolean
            • sourceRepo (optional)
              • Type: String
            • status (optional)
              • Type: String

            rtPublishBuildInfo: Publish build info

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

            rtServer: Creates new Artifactory server

            • id
              • Type: String
            • bypassProxy (optional)
              • Type: boolean
            • credentialsId (optional)
              • Type: String
            • password (optional)
              • Type: String
            • retry (optional)
              • Type: int
            • timeout (optional)
              • Type: int
            • url (optional)
              • Type: String
            • username (optional)
              • Type: String

            rtSetProps: Set properties

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

            rtUpload: Upload artifacts

            • serverId
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • failNoOp (optional)
              • Type: boolean
            • module (optional)
              • Type: String
            • spec (optional)
              • Type: String
            • specPath (optional)
              • Type: String

            runConanCommand: Run a Conan command

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

            xrayScan: run Xray scan

            • serverId
              • Type: String
            • buildName (optional)
              • Type: String
            • buildNumber (optional)
              • Type: String
            • failBuild (optional)
              • Type: boolean

            xrayScanBuild: Xray build scanning

            • xrayScanConfig
                org.jfrog.hudson.pipeline.common.types.XrayScanConfig
            • server
                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.