You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/setup.mdx
+36-1Lines changed: 36 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,8 @@ import TabItem from '@theme/TabItem';
10
10
## Download and Run
11
11
12
12
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.
14
15
If you want to run it on another platform,
15
16
you can [build the CLI from source][cli-source].
16
17
@@ -140,6 +141,40 @@ follow the instructions for **your platform** below:
140
141
oasis --version
141
142
```
142
143
</TabItem>
144
+
145
+
<TabItemvalue="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.
0 commit comments