Skip to content

Commit c9baf9d

Browse files
committed
docs(): Add GitHub action link for Oasis CLI
1 parent 28cfc20 commit c9baf9d

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,6 @@ It boasts a number of handy features:
4545
calls
4646
- debugging tools for deployed Wasm contracts
4747
- inspection of blocks, transactions, results and events
48+
- install via
49+
[GitHub Action](https://github.com/oasisprotocol/setup-cli-action)
4850

docs/setup.mdx

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ import TabItem from '@theme/TabItem';
1010
## Download and Run
1111

1212
The Oasis team provides CLI binaries for Linux,
13-
macOS and Windows operating systems.
13+
macOS and Windows operating systems, as well as
14+
a GitHub Action for CI/CD installs.
1415
If you want to run it on another platform,
1516
you can [build the CLI from source][cli-source].
1617

@@ -140,6 +141,40 @@ follow the instructions for **your platform** below:
140141
oasis --version
141142
```
142143
</TabItem>
144+
145+
<TabItem value="gh-action" label="GitHub Action">
146+
To setup Oasis CLI for GitHub CI/CD workflows, we recommend using our [setup-cli-action](https://github.com/oasisprotocol/setup-cli-action) GitHub Action.
147+
148+
#### Setup
149+
150+
Simply add a Setup Oasis CLI step to your workflow:
151+
152+
```yaml
153+
steps:
154+
- name: Setup Oasis CLI
155+
uses: oasisprotocol/setup-cli-action
156+
```
157+
158+
#### Verify
159+
160+
```yaml
161+
- name: Check Oasis CLI version
162+
run: oasis --version
163+
```
164+
165+
#### Configuration
166+
167+
Optionally you can use the version parameter to install a different version of the CLI.
168+
169+
```yaml
170+
steps:
171+
- name: Setup Oasis CLI
172+
uses: oasisprotocol/setup-cli-action
173+
with:
174+
version: '0.14.3'
175+
```
176+
</TabItem>
177+
143178
</Tabs>
144179
145180
## Update

0 commit comments

Comments
 (0)