Skip to content

Commit 0203606

Browse files
authored
Merge pull request #300 from OctopusDeploy/v1.2
chore: updated distributable and README for v1.2
2 parents a57993d + 83305db commit 0203606

File tree

2 files changed

+454
-52
lines changed

2 files changed

+454
-52
lines changed

README.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,48 @@ This is a GitHub Action to install the [Octopus CLI](https://octopus.com/docs/oc
88

99
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.
1010

11+
## Features
12+
13+
- Download, install, and cache Octopus CLI to be used in workflows
14+
- Supports SemVer-based version numbers with wildcards (i.e. `8.*`) but not ranges
15+
1116
## Examples
1217

13-
To install the latest version of the Octopus CLI:
18+
To install the latest version (i.e. `*` or `latest`) of the Octopus CLI:
1419

1520
```yml
16-
steps:
17-
- uses: actions/checkout@v2
18-
- name: Install Octopus CLI 🐙
19-
uses: OctopusDeploy/install-octopus-cli-action@<version>
20-
with:
21-
version: latest
21+
- name: Install Octopus CLI 🐙
22+
uses: OctopusDeploy/install-octopus-cli-action@v1.2.0
23+
with:
24+
version: '*'
2225
```
2326
2427
To install a specific version of the Octopus CLI:
2528
2629
```yml
27-
steps:
28-
- uses: actions/checkout@v2
29-
- name: Install Octopus CLI 🐙
30-
uses: OctopusDeploy/install-octopus-cli-action@<version>
31-
with:
32-
version: 7.4.3140
30+
- name: Install Octopus CLI 🐙
31+
uses: OctopusDeploy/install-octopus-cli-action@v1.2.0
32+
with:
33+
version: 9.0.0
3334
```
3435
3536
Here's an example of invoking the `list-deployments` command after installing the Octopus CLI:
3637

3738
```yml
38-
steps:
39-
- uses: actions/checkout@v2
40-
- name: Install Octopus CLI 🐙
41-
uses: OctopusDeploy/install-octopus-cli-action@<version>
42-
with:
43-
version: 7.4.3190
44-
- name: list-octopusdeploy-deployments
45-
run: >
46-
octo list-deployments --server=${{ env.serverURL }}
47-
--apiKey=${{ secrets.apiKey }}
39+
- name: Install Octopus CLI 🐙
40+
uses: OctopusDeploy/install-octopus-cli-action@v1.2.0
41+
with:
42+
version: 9.0.0
43+
- name: list-octopusdeploy-deployments
44+
run: >
45+
octo list-deployments --server=${{ env.serverURL }}
46+
--apiKey=${{ secrets.apiKey }}
4847
```
4948

5049
## 📥 Inputs
5150

5251
The following input is optional:
5352

54-
| Name | Description | Default |
55-
| :-------- | :------------------------------------------------------------------------------- | :------: |
56-
| `version` | The version number of the Octopus CLI to download and install (i.e. `7.4.3190`). | `latest` |
53+
| Name | Description | Default |
54+
| :-------- | :------------------------------------------------------------------------------- | :----------: |
55+
| `version` | The version number of the Octopus CLI to download and install (i.e. `7.4.3190`). | `*` (latest) |

0 commit comments

Comments
 (0)