From c4569765df6c13ffc21d96f695f196e28c54f6aa Mon Sep 17 00:00:00 2001 From: Jake Dawkins Date: Wed, 7 Apr 2021 11:36:14 -0400 Subject: [PATCH] Update install instructions to use a static url (#426) * update install instructions for static url * update ci/cd instructions --- README.md | 18 ++++++++++++------ docs/source/ci-cd.md | 4 ++-- docs/source/getting-started.md | 19 +++++++++++++------ 3 files changed, 27 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9c25a1492..4f0153f96 100644 --- a/README.md +++ b/README.md @@ -106,26 +106,32 @@ This repo is organized as a [`cargo` workspace], containing several related proj #### Linux and MacOS `curl | sh` installer +To install the latest release of Rover: + ```bash -curl -sSL https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/nix/install.sh | sh +curl -sSL https://rover.apollo.dev/nix/latest | sh ``` -**To download older versions of Rover**, use the `VERSION` env variable when executing the installer (note: the `v` in the version number): +To install a specific version of Rover (note the `v` prefixing the version number): + +> Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise. ```bash -curl -sSL https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/nix/install.sh | VERSION=v0.0.1 sh +curl -sSL https://rover.apollo.dev/nix/v0.0.7 | sh ``` #### Windows PowerShell installer ```bash -iwr 'https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/windows/install.ps1' | iex +iwr 'https://rover.apollo.dev/win/latest' | iex ``` -**To download older versions of Rover**, use the `VERSION` env variable when executing the installer (note: the `v` in the version number): +To install a specific version of Rover (note the `v` prefixing the version number): + +> Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise. ```bash -$Env:VERSION='v0.0.1'; iwr 'https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/windows/install.ps1' | iex +iwr 'https://rover.apollo.dev/win/v0.0.7' | iex ``` #### npm installer diff --git a/docs/source/ci-cd.md b/docs/source/ci-cd.md index e07236515..b2536fee9 100644 --- a/docs/source/ci-cd.md +++ b/docs/source/ci-cd.md @@ -39,7 +39,7 @@ jobs: name: Install command: | # download and install Rover - curl -sSL https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/nix/install.sh | sh + curl -sSL https://rover.apollo.dev/nix/v0.0.7 | sh # This allows the PATH changes to persist to the next `run` step echo 'export PATH=$HOME/.rover/bin:$PATH' >> $BASH_ENV @@ -97,7 +97,7 @@ jobs: - name: Install Rover run: | - curl -sSL https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/nix/install.sh | sh + curl -sSL https://rover.apollo.dev/nix/v0.0.7 | sh # Add Rover to the $GITHUB_PATH so it can be used in another step # https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path diff --git a/docs/source/getting-started.md b/docs/source/getting-started.md index b482c00a4..8a2151af1 100644 --- a/docs/source/getting-started.md +++ b/docs/source/getting-started.md @@ -9,25 +9,32 @@ The Rover CLI is available for Linux, Mac, and Windows. #### Linux and MacOS `curl | sh` installer +To install the latest release of Rover: + ```bash -curl -sSL https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/nix/install.sh | sh +curl -sSL https://rover.apollo.dev/nix/latest | sh ``` -**To download older versions of Rover**, use the `VERSION` env variable when executing the installer (note: the `v` in the version number): +To install a specific version of Rover (note the `v` prefixing the version number): + +> Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise. ```bash -curl -sSL https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/nix/install.sh | VERSION=v0.0.1 sh +curl -sSL https://rover.apollo.dev/nix/v0.0.7 | sh ``` + #### Windows PowerShell installer ```bash -iwr 'https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/windows/install.ps1' | iex +iwr 'https://rover.apollo.dev/win/latest' | iex ``` -**To download older versions of Rover**, use the `VERSION` env variable when executing the installer (note: the `v` in the version number): +To install a specific version of Rover (note the `v` prefixing the version number): + +> Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise. ```bash -$Env:VERSION='v0.0.1'; iwr 'https://raw.githubusercontent.com/apollographql/rover/v0.0.7/installers/binstall/scripts/windows/install.ps1' | iex +iwr 'https://rover.apollo.dev/win/v0.0.7' | iex ``` #### npm installer