Octopus Deploy Plugin

This topic introduces the Octopus Deploy Plugin for Release, which facilitates integration with Octopus Deploy for managing deployments within release pipelines.

The Release Octopus Deploy plugin allows you to create releases and trigger deployments on Octopus Deploy through the Release platform. The following task types are included:

• Octopus: Create Release
• Octopus: Deploy

In addition, the following task types were imported from the Octopus Deploy community plugin:

• Octopus: Get Environment Id
• Octopus: Get Project Id
• Octopus: Get Project Package Information
• Octopus: Get Project Version

These deprecated task types are included with the officially-supported plugin so as not to break templates and releases that used the community plugin. However, each of these task's functionality has been included in the Octopus: Create release and Octopus: Deploy task types. New users can ignore these tasks and simply use the Create Release and Deploy task types when integrating Octopus Deploy into releases and templates.

Note: With Release 23.1, the Abort task logic is added to the Octopus Deploy plugin.

Features

• Create a release
• Trigger a deployment

Requirements

The Octopus Deploy plugin requires the following:

• Release 10.0.x or higher

Installation

1. Copy the latest JAR file from the Deploy/Release Distribution Site into the XL_RELEASE_SERVER/plugins/xlr-official directory.
2. Restart the Release server.

Server Connection Configuration

1. Go to Settings Shared Configuration.
2. Add Octopus:server.
3. Enter the Title, API URL, and API Key.
4. Check the server connection.
5. Configure the build setup with number of retries (Retry Count) and interval time (Retry Waiting Time which depends on the estimated deploy time).

Create a release

You can use the Octopus: Create Release task to create an Octopus Deploy release by providing the project name and Octopus channel to use for the release. You can provide a version name to use for the release, or if the field is left blank, the plugin will automatically increment from the most recent previous release version. You can also provide specific package version information in JSON format, or leave the field blank to allow the plugin to use the most recent package versions.

Trigger a deployment

You can use the Octopus: Deploy task to trigger an Octopus deployment by providing the name of the project and release to deploy, and the environment in which to execute the deployment.

Deprecated tasks

The following task types are now integrated into the Octopus: Create Release and Octopus: Deploy tasks, but they still function to support legacy users of the community plugin who may have these tasks integrated with templates and releases. We recommend replacing these deprecated task types with the ones available in the officially-supported Octopus Deploy plugin.

Get environment ID

Although this task is deprecated, you can still get the technical environment ID of an Octopus Deploy project by providing its human-readable name.

Get project ID

Although this task is deprecated, you can still get the technical project ID of an Octopus Deploy project by providing its human-readable name.

Get project package information

Although this task is deprecated, you can still get package version information for an Octopus Deploy project by providing the technical project ID. The needed ID can be found using the Get project ID task.

Get project version

Although this task is deprecated, you can still get the previous version of an Octopus Deploy project by providing the technical project ID. The needed ID can be found using Get project ID task.