From 1b4013293d48677a88f07c996030bfcbfea227ea Mon Sep 17 00:00:00 2001 From: njelich <12912633+njelich@users.noreply.github.com> Date: Fri, 16 Jan 2026 15:47:45 +0100 Subject: [PATCH] docs(): Add GitHub action link for Oasis CLI --- README.md | 5 +++++ docs/README.md | 2 ++ docs/setup.mdx | 39 ++++++++++++++++++++++++++++++++++++++- 3 files changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ec451845..427c73e4 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,11 @@ This is the official command-line interface (CLI) for interacting with the [Oasis Runtime SDK]: https://github.com/oasisprotocol/oasis-sdk/tree/main/runtime-sdk +## Installation + +For multiple Oasis CLI installation methods, please +refer to the [Setup Guide](docs/setup.mdx). + ## Building To build the CLI, run the following: diff --git a/docs/README.md b/docs/README.md index b19b40e8..e06b5fdd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -45,4 +45,6 @@ It boasts a number of handy features: calls - debugging tools for deployed Wasm contracts - inspection of blocks, transactions, results and events + - install via + [GitHub Action](https://github.com/oasisprotocol/setup-cli-action) \ No newline at end of file diff --git a/docs/setup.mdx b/docs/setup.mdx index 54873977..ef45a8ec 100644 --- a/docs/setup.mdx +++ b/docs/setup.mdx @@ -10,7 +10,8 @@ import TabItem from '@theme/TabItem'; ## Download and Run The Oasis team provides CLI binaries for Linux, -macOS and Windows operating systems. +macOS and Windows operating systems, as well as +a GitHub Action for CI/CD installs. If you want to run it on another platform, you can [build the CLI from source][cli-source]. @@ -140,6 +141,42 @@ follow the instructions for **your platform** below: oasis --version ``` + + + 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. + + #### Setup + + Simply add a Setup Oasis CLI step to your workflow: + + ```yaml + steps: + - name: Setup Oasis CLI + uses: oasisprotocol/setup-cli-action + ``` + + #### Verify + + ```yaml + - name: Check Oasis CLI version + run: oasis --version + ``` + + #### Configuration + + Optionally you can use the version parameter to install a different version of the CLI. + + ```yaml + steps: + - name: Setup Oasis CLI + uses: oasisprotocol/setup-cli-action + with: + version: '0.14.3' + ``` + + ## Update