From 19514c66dd20a2037bf92840ca6a0057ec72b802 Mon Sep 17 00:00:00 2001 From: Varun Gandhi Date: Wed, 10 Jul 2024 11:44:18 +0800 Subject: [PATCH] docs: Update download instructions in README --- .github/workflows/release-template.md | 1 + README.md | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release-template.md b/.github/workflows/release-template.md index 4d25e5274..fca0f93d5 100644 --- a/.github/workflows/release-template.md +++ b/.github/workflows/release-template.md @@ -1,5 +1,6 @@ Download the binary for your platform using: + ```bash TAG=TAG_PLACEHOLDER \ ARCH="$(uname -m)" \ diff --git a/README.md b/README.md index f72623471..f1b4d3454 100644 --- a/README.md +++ b/README.md @@ -89,8 +89,12 @@ You can download a [release binary](https://github.com/sourcegraph/scip-ruby/releases) and run it directly, similar to invoking Sorbet. + ```bash -curl -L "https://github.com/sourcegraph/scip-ruby/releases/latest/download/scip-ruby-x86_64-$(uname -s | tr '[:upper:]' '[:lower:]')" -o scip-ruby && chmod +x scip-ruby +ARCH="$(uname -m)" \ +OS="$(uname -s | tr '[:upper:]' '[:lower:]')" \ +bash -c 'curl -L "https://github.com/sourcegraph/scip-ruby/releases/latest/download/scip-ruby-$ARCH-$OS" -o scip-ruby' && \ +chmod +x scip-ruby # If using in CI with 'set -e', make sure to wrap the # scip-ruby invocation in 'set +e' followed by 'set -e'