Skip to content

docs(cli): Add version specifier to get-cli script #4991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/docs/product/cli/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ If you are on OS X or Linux, you can use the automated downloader which will fet
curl -sL https://sentry.io/get-cli/ | bash
```

We do however, encourage you to pin the specific version of the CLI, so your builds are always reproducible.
To do that, you can use the exact same method, with an additional version specifier:

```bash
curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION="{{ apps.version('sentry-cli') }}" bash }}
```

This will automatically download the correct version of `sentry-cli` for your operating system and install it. If necessary, it will prompt for your admin password for `sudo`. For a different installation location or for systems without `sudo` (like Windows), you can `export INSTALL_DIR=/custom/installation/path` before running this command.

To verify it’s installed correctly you can bring up the help:
Expand Down Expand Up @@ -102,7 +109,6 @@ Options listed below control how `sentry-cli` install script behaves, when insta

: If set, the script will change where it writes its output. Possible values are `stdout` and `stderr`. Defaults to `stdout`.


## Installation via Homebrew

If you are on OS X, you can install `sentry-cli` via homebrew:
Expand Down
7 changes: 6 additions & 1 deletion src/gatsby/config.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import queries from "./utils/algolia";
import AppRegistry from "./utils/appRegistry";
import PackageRegistry from "./utils/packageRegistry";
import resolveOpenAPI from "./utils/resolveOpenAPI";

const packages = new PackageRegistry();
const apps = new AppRegistry();

const activeEnv =
process.env.GATSBY_ENV || process.env.NODE_ENV || "development";
Expand All @@ -12,7 +14,9 @@ const root = `${__dirname}/../..`;
process.env.DISABLE_THUMBNAILS = process.env.DISABLE_THUMBNAILS || "0";
if (process.env.DISABLE_THUMBNAILS === "1") {
console.log("🐇 Thumbnail generation is disabled.");
console.log("WARN: DISABLE_THUMBNAILS should no longer yield significant build time boosts with `yarn develop`. Let @markus know if it does.");
console.log(
"WARN: DISABLE_THUMBNAILS should no longer yield significant build time boosts with `yarn develop`. Let @markus know if it does."
);
}

const getPlugins = () => {
Expand All @@ -25,6 +29,7 @@ const getPlugins = () => {
options: {
scope: {
packages,
apps,
},
excludeExpr: ["default"],
},
Expand Down