Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/octopusdeploy/install-octopus-cli-action
| Public | :octocat: GitHub Action to Install the Octopus CLI
https://github.com/octopusdeploy/install-octopus-cli-action
cli continuous-delivery deployment github-actions octopus-deploy public
Last synced: 4 days ago
JSON representation
| Public | :octocat: GitHub Action to Install the Octopus CLI
- Host: GitHub
- URL: https://github.com/octopusdeploy/install-octopus-cli-action
- Owner: OctopusDeploy
- License: other
- Created: 2020-10-19T14:26:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-09T04:35:50.000Z (4 months ago)
- Last Synced: 2024-10-14T13:01:58.641Z (3 months ago)
- Topics: cli, continuous-delivery, deployment, github-actions, octopus-deploy, public
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/install-octopus-cli
- Size: 11.2 MB
- Stars: 81
- Watchers: 17
- Forks: 18
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# install-octopus-cli-action
This is a GitHub Action to install the new [Octopus CLI](https://octopus.com/blog/building-octopus-cli-vnext#introducing-the-new-octopus-cli-octopus) (`octopus`) on runners and self-hosted environments. Once installed, the Octopus CLI may be used to issue commands to [Octopus Deploy](https://octopus.com/). 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](https://octopus.com/docs/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](migration-guide.md) if moving between major versions of this action.
## Examples
To install the latest version (i.e. `*` or `latest`) of the Octopus CLI:
```yml
- name: Install Octopus CLI 🐙
uses: OctopusDeploy/install-octopus-cli-action@v3
with:
version: '*'
```
To install a specific version of the Octopus CLI:
```yml
- name: Install Octopus CLI 🐙
uses: OctopusDeploy/install-octopus-cli-action@v3
with:
version: 0.8.0
```
Here's an example of invoking the `account list` command after installing the Octopus CLI:
```yml
- name: Install Octopus CLI 🐙
uses: OctopusDeploy/install-octopus-cli-action@v3
with:
version: 0.8.0
- name: list-octopusdeploy-accounts
env:
OCTOPUS_API_KEY: ${{ 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](https://github.com/OctopusDeploy/cli/releases) 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](CONTRIBUTING.md) for information about how to get involved in this project.