Jenkins Pipeline projects

This page lists the arguments you can supply to the Octopus Jenkins Pipelines commands to run against your Octopus Deploy server.

The Jenkins Pipeline support requires plugin version 3.0.0 or later and Jenkins version 2.190.1 or later.

Pack

Step name: octopusPack

octopusPack allows you to create a package from files on disk during your pipeline execution.

Example:

octopusPack \
  additionalArgs: '-author "My Company"', \
  outputPath: './artifacts/', \
  overwriteExisting: false, \
  packageFormat: 'zip', \
  packageId: 'OctoPetShop', \
  packageVersion: '1.1.${BUILD_NUMBER}', \
  sourcePath: './bin/Release/publish/', \
  toolId: 'octocli', \
  verboseLogging: false

Push

Step name: octopusPushPackage

octopusPushPackage allows you to push packages to the package repository in an Octopus Server.

Example:

octopusPushPackage \
  overwriteMode: 'FailIfExists', \
  packagePaths: './artifacts/OctoPetShop.1.1.${BUILD_NUMBER}.zip', \
  serverId: 'octopus-server', \
  spaceId: 'Spaces-1', \
  toolId: 'octocli'

Examples for the packagePaths parameter:

Absolute path

The path to the package can be provided as an absolute path on the Jenkins server or Agent. ${WORKSPACE} is the directory which the job runs within.

• packagePaths: "${WORKSPACE}/artifacts/Package.0.0.${BUILD_NUMBER}.zip".
• packagePaths: "/home/jenkins/workspace/artifacts/Package.0.0.${BUILD_NUMBER}.zip".

Relative path

The path is a relative path from the WORKSPACE directory.

• packagePaths: "artifacts/Package.0.0.${BUILD_NUMBER}.zip"

Glob Patterns

The package selection can also be done using ANT glob patterns.

• packagePaths: "artifacts/**/*.0.0.${BUILD_NUMBER}.zip".
  • This will pick up all the packages, in all folders under the artifacts directory with a name matching the 0.0 version and current build number.

Multiple paths

The packagePaths parameter also supports multiple values from the above options separated by a \n character.

• packagePaths: "artifacts/package1/Package1.0.0.${BUILD_NUMBER}.zip\nartifacts/package2/Package2.0.0.${BUILD_NUMBER}.zip"

Push package info

Step: octopusPushBuildInformation

octopusPushBuildInformation allows you to push package information to an Octopus Server.

Example:

octopusPushBuildInformation \
  toolId: 'octocli', \
  serverId: 'octopus-server', \
  spaceId: 'Spaces-1', \
  commentParser: 'GitHub', \
  overwriteMode: 'FailIfExists', \
  packageId: 'OctoPetShopService', \
  packageVersion: '1.2.${BUILD_NUMBER}', \
  verboseLogging: false, \
  additionalArgs: '--debug', \
  gitUrl: 'https://github.com/OctopusSamples/OctoPetShop', \
  gitBranch: '${GIT_BRANCH}', \
  gitCommit: '${GIT_COMMIT}'

Due to limitations in Jenkins Pipelines, you will need to pass the Git URL, Git Branch and Git Commit values to the octopusPushBuildInformation. Including these values will allow the build information to provide correct URL links to the source.

For a pipeline source from SCM, set the parameters to gitUrl: '${GIT_URL}' gitBranch: '${GIT_BRANCH}' gitCommit: '${GIT_COMMIT}', the checkoutVars script will not be required. For a inline pipeline definition configure the step as:

steps {
    script {
        def checkoutVars = checkout([$class: 'GitSCM', userRemoteConfigs: [[url: 'https://github.com/OctopusSamples/RandomQuotes-Java.git']]])
        env.GIT_URL = checkoutVars.GIT_URL
        env.GIT_BRANCH = checkoutVars.GIT_BRANCH
        env.GIT_COMMIT = checkoutVars.GIT_COMMIT
    }
    octopusPushBuildInformation commentParser: 'GitHub', overwriteMode: 'FailIfExists', packageId: 'randomquotes', packageVersion: "1.0.${BUILD_NUMBER}", serverId: "octopus-server", spaceId: "Spaces-2", toolId: 'Default', gitUrl: "${GIT_URL}", gitBranch: "${GIT_BRANCH}", gitCommit: "${GIT_COMMIT}"
}

Create release

Step: octopusCreateRelease

octopusCreateRelease allows you to push packages to the package repository in an Octopus Server.

Example:

octopusCreateRelease \
  serverId: 'octopus-server', \
  spaceId: 'Spaces-1', \
  project: 'Random Quotes', \
  releaseVersion: '2.3.${BUILD_NUMBER}', \
  toolId: 'octocli', \
  packageConfigs: [[packageName: 'Nuget.CommandLine', packageReferenceName: 'NugetCLI', packageVersion: '5.5.1']], \
  deployThisRelease: true, \
  cancelOnTimeout: false, \
  deploymentTimeout: '00:15:00', \
  environment: 'test', \
  tenant: 'The Tenant', \
  tenantTag: 'importance/high', \
  jenkinsUrlLinkback: true, \
  releaseNotes: true, \
  releaseNotesSource: 'scm'

Deploy release

Step: octopusDeployRelease

octopusDeployRelease allows you to push packages to the package repository in an Octopus Server.

Example:

octopusDeployRelease \
  toolId: 'octocli', \
  serverId: 'octopus-server', \
  spaceId: 'Spaces-1', \
  project: 'OctoPetShop', \
  environment: 'test', \
  releaseVersion: '1.2.${BUILD_NUMBER}', \
  deploymentTimeout: '00:05:00', \
  waitForDeployment: false, \
  cancelOnTimeout: true

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023