install-octopus-cli-action

This is a GitHub Action to install the new Octopus CLI (octopus) 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.

Features

• Download, install, and cache Octopus CLI to be used in workflows
• Supports SemVer-based version numbers with wildcards (i.e. 0.8.*) but not ranges

Migration Guide(s)

Please refer to the migration guide if moving between major versions of this action.

Examples

To install the latest version (i.e. * or latest) of the Octopus CLI:

- name: Install Octopus CLI 🐙
  id: installoctopuscli
  uses: OctopusDeploy/install-octopus-cli-action@v4
  with:
    version: '*'

To install a specific version of the Octopus CLI:

- name: Install Octopus CLI 🐙
  id: installoctopuscli
  uses: OctopusDeploy/install-octopus-cli-action@v4
  with:
    version: 0.8.0

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

- name: Install Octopus CLI 🐙
  id: installoctopuscli
  uses: OctopusDeploy/install-octopus-cli-action@v4
  with:
    version: 0.8.0
name: list-octopusdeploy-accounts
  id: listoctopusdeployaccounts
  env:
    OCTOPUSAPIKEY: ${{ secrets.apiKey }}
    OCTOPUS_URL: ${{ secrets.serverURL }}
    OCTOPUS_SPACE: 'Outer Space'
  run: >
    octopus account list

📥 Inputs

The following input is optional:

| Name | Description | Default | | :-------- | :------------------------------------------------------------------------------------------------------------------------------------- | :----------: | | version | The release version number of the Octopus CLI to download and install (e.g. 0.8.0). | * (latest) |

🤝 Contributions

Contributions are welcome! :heart: Please read our Contributing Guide for information about how to get involved in this project.