install-octopus-cli-action

This is a GitHub Action to install the Octopus CLI on runners and self-hosted environments. Once installed, the Octopus CLI may be used to issue commands to Octopus Deploy. Subsequent actions may use the Octopus CLI, which is cached and available via PATH.

What is the Octopus CLI?

The Octopus CLI is a command line tool that builds on top of the Octopus REST API. It enables you to package applications for deployment and manage your environments, deployments, channels, projects, and workers in Octopus Deploy.

Examples

To install the latest version of the Octopus CLI:

steps:
  - uses: actions/checkout@v2
  - name: Install Octopus CLI 🐙
    uses: OctopusDeploy/install-octopus-cli-action@<version>
    with:
      version: latest

To install a specific version of the Octopus CLI:

steps:
  - uses: actions/checkout@v2
  - name: Install Octopus CLI 🐙
    uses: OctopusDeploy/install-octopus-cli-action@<version>
    with:
      version: 7.4.3140

Here's an example of invoking the list-deployments command after installing the Octopus CLI:

steps:
  - uses: actions/checkout@v2
  - name: Install Octopus CLI 🐙
    uses: OctopusDeploy/install-octopus-cli-action@<version>
    with:
      version: 7.4.3190
  - name: list-octopusdeploy-deployments
    run: >
      octo list-deployments --server=${{ env.serverURL }}
        --apiKey=${{ secrets.apiKey }}

📥 Inputs

The following input is optional:

Name	Description	Default
version	The version number of the Octopus CLI to download and install (i.e. 7.4.3190).	latest