> User Documentation Home

User Handbook
Tutorials
Resources

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.

Octopus Deploy

View this plugin on the Plugins site

octopusDeployRelease: Octopus Deploy: Deploy Release

  • serverId
    The identifier of the Octopus Server instance which you want to use for deploying this release.
    Server Id is set in the global OctopusDeploy Plugin configuration.
    • Type: String
  • toolId
    The Octopus Deploy Command Line executable which you want to use for creating this release.
    Octopus Deploy Command Line executable is set in the Octopus CLI configuration on the Global Tool Configuration page.
    • Type: String
  • spaceId
    If left empty the Default space for the Octopus Server instance will be used.
    Otherwise, specify a space by name. The space specified must exist in the Octopus Server instance.
    • Type: String
  • project
    The project name in OctopusDeploy.
    This field is case-sensitive.
    • Type: String
  • releaseVersion
    The version of the release to move.
    This field is case-sensitive.
    • Type: String
  • environment (optional)
    The environment to deploy to.
    This field is case-sensitive.
    • Type: String
  • additionalArgs (optional)
    Additional arguments to be passed to the Octo executable.
    • Type: String
  • cancelOnTimeout (optional)
    If checked then the deployment will be explicitly canceled if the time to wait has expired and the task has not completed.
    • Type: boolean
  • deploymentTimeout (optional)
    The amount of time, specified in timespan format, to wait for the deployment to complete. Default is 00:10:00 if left blank. The deployment task itself does not timeout, this timeout is purely how long the client will keep polling to see if it has completed.
    • Type: String
  • tenant (optional)
    The tenant to deploy to.
    This field is case-sensitive.
    • Type: String
  • tenantTag (optional)
    • Type: String
  • variables (optional)
    List of variable to pass to the Deployment process
    Use Java properties notation, e.g. propertyName=propertyValue each on a new line For pipeline syntax separate each entry with a new-line character \n
    • Type: String
  • verboseLogging (optional)
    • Type: boolean
  • waitForDeployment (optional)
    If selected, this build will wait until the deployment is complete.
    When this is selected, the deployment state will fail the build if the state ends as "Failed"
    • Type: boolean

octopusPack: Octopus Deploy: Package application

  • toolId
    The Octopus Deploy Command Line executable
    • Type: String
  • packageId
    The ID of the package; e.g. MyCompany.MyApp
    • Type: String
  • packageFormat
    ZIP is the recommended format.
    • Type: String
  • sourcePath
    The root folder containing files and folders to pack. Defaults to the working directory.
    • Type: String
  • additionalArgs (optional)
    Additional arguments to be passed to the Octo executable.
    • Type: String
  • includePaths (optional)
    Newline-separated files to include in the package. Defaults to **
    • Type: String
  • outputPath (optional)
    The folder into which the generated package file will be written. Defaults to the working directory.
    • Type: String
  • overwriteExisting (optional)
    Overwrite any existing package
    • Type: boolean
  • packageVersion (optional)
    The version number of the package. Defaults to a timestamp-based version.
    • Type: String
  • verboseLogging (optional)
    Enable debug logging
    • Type: boolean

octopusPushBuildInformation: Octopus Deploy: Push build information

  • serverId
    The identifier of the Octopus Server instance which you want to use for deploying this release.
    Server Id is set in the global OctopusDeploy Plugin configuration.
    • Type: String
  • spaceId
    If left empty the Default space for the Octopus Server instance will be used.
    Otherwise, specify a space by name. The space specified must exist in the Octopus Server instance.
    • Type: String
  • toolId
    The Octopus Deploy Command Line executable
    • Type: String
  • packageId
    Newline-separated package IDs; e.g.
    MyCompany.MyApp
    MyCompany.MyApp2
    • Type: String
  • packageVersion
    The version number of the package. Defaults to a timestamp-based version.
    • Type: String
  • commentParser
    Octopus can associate the work items or issues addressed by the changes in the package to the package. Select the issue tracking system that you use, or leave this option blank if you do not use a supported issue tracker.
    • Type: String
  • overwriteMode
    Normally, if the same build information already exists on the server, the server will reject the build information push. This practice ensures build information isn't accidentally overwritten or ignored. Enable this setting to override allow build information to be overwritten.
    • Values: FailIfExists, OverwriteExisting, IgnoreIfExists
  • additionalArgs (optional)
    Additional arguments to be passed to the Octo executable.
    • Type: String
  • gitBranch (optional)
    • Type: String
  • gitCommit (optional)
    • Type: String
  • gitUrl (optional)
    • Type: String
  • verboseLogging (optional)
    • Type: boolean

octopusPushPackage: Octopus Deploy: Push packages

  • serverId
    The identifier of the Octopus Server instance which you want to use for deploying this release.
    Server Id is set in the global OctopusDeploy Plugin configuration.
    • Type: String
  • toolId
    The Octopus Deploy Command Line executable
    • Type: String
  • packagePaths
    Newline-separated paths of package files that will be pushed. Ant-style wildcards like dir/**/*.zip are supported.
    • Type: String
  • overwriteMode
    Normally, if the same package already exists on the server, the server will reject the package push. This practice ensures a package isn't accidentally overwritten or ignored. Use this setting to override this behavior.
    • Values: FailIfExists, OverwriteExisting, IgnoreIfExists
  • additionalArgs (optional)
    Additional arguments to be passed to the Octo executable.
    • Type: String
  • spaceId (optional)
    If left empty the Default space for the Octopus Server instance will be used.
    Otherwise, specify a space by name. The space specified must exist in the Octopus Server instance.
    • Type: String
  • verboseLogging (optional)
    Enable debug logging
    • Type: boolean

octopusCreateRelease: Octopus Deploy: Create Release

  • serverId
    The identifier of the Octopus Server instance which you want to use for creating this release.
    Server Id is set in the global OctopusDeploy Plugin configuration.
    • Type: String
  • toolId
    The Octopus Deploy Command Line executable which you want to use for creating this release.
    Octopus Deploy Command Line executable is set in the Octopus CLI configuration on the Global Tool Configuration page.
    • Type: String
  • project
    The name of the project as defined in OctopusDeploy.
    This field is case sensitive.
    • Type: String
  • releaseVersion
    The version of the release to create.
    • Type: String
  • spaceId (optional)
    If left empty the Default space for the Octopus Server instance will be used.
    Otherwise, specify a space by name. The space specified must exist in the Octopus Server instance.
    • Type: String
  • additionalArgs (optional)
    Additional arguments to be passed to the Octo executable.
    • Type: String
  • cancelOnTimeout (optional)
    If checked then the deployment will be explicitly canceled if the time to wait has expired and the task has not completed.
    • Type: boolean
  • channel (optional)
    If left empty the Default channel for the project will be used.
    Otherwise, specify a channel by name. The channel specified must exist for the current project.
    • Type: String
  • defaultPackageVersion (optional)
    The default version to use for all required packages that are not specified in Package Configurations. No default packages are used if a default version is not specified
    • Type: String
  • deployThisRelease (optional)
    Select this when this release should be deployed immediately after it is created.
    • Type: boolean
  • deploymentTimeout (optional)
    The amount of time, specified in timespan format, to wait for the deployment to complete. Default is 00:10:00 if left blank. The deployment task itself does not timeout, this timeout is purely how long the client will keep polling to see if it has completed.
    • Type: String
  • environment (optional)
    The environment to deploy this release into.
    • Type: String
  • gitCommit (optional)
    Git commit to use when creating the release for a version controlled Octopus Project.
    Use in conjunction with the GitRef parameter to select any previous commit.
    • Type: String
  • gitRef (optional)
    Git reference to use when creating the release for a version controlled Octopus Project.
    • Type: String
  • jenkinsUrlLinkback (optional)
    Adds a linkback to the Jenkins build that created the release in the Octopus Deploy release notes
    • Type: boolean
  • packageConfigs (optional)
      Array / List of Nested Object
    • packageName
      The step-name that requires a version for a nuget package.
      This field is case-sensitive.
      • Type: String
    • packageReferenceName
      The package reference name within the step. This value is required only if you are using the package referencing feature.
      This field is case-sensitive.
      • Type: String
    • packageVersion
      The package's version for this release.
      This field is case-sensitive.
      • Type: String
  • releaseNotes (optional)
    Select this option when you want to include release notes in this release.
    • Type: boolean
  • releaseNotesFile (optional)
    Path to file, relative from workspace root, to read for release notes.
    • Type: String
  • releaseNotesSource (optional)
    • Type: String
  • tenant (optional)
    The tenant to deploy to.
    This field is case-sensitive.
    • Type: String
  • tenantTag (optional)
    • Type: String
  • variables (optional)
    List of variable to pass to the Deployment process
    Use Java properties notation, e.g. propertyName=propertyValue each on a new line. For pipeline syntax separate each entry with a new-line character \n
    • Type: String
  • verboseLogging (optional)
    • Type: boolean
  • waitForDeployment (optional)
    If selected, this build will wait until the deployment is complete.
    When this is selected, the deployment state will fail the build if the state ends as "Failed"
    • Type: boolean

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.