@sentry/cli 1.75.2 → 1.77.0

package/README.md

@@ -1,6 +1,11 @@
 <p align="center">
-    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
-    <br />
+  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+    <picture>
+      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-white.png" media="(prefers-color-scheme: dark)" />
+      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
+      <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry" width="280">
+    </picture>
+  </a>
 </p>
 
 # Official Sentry Command Line Interface
@@ -12,7 +17,7 @@
 
 This is a Sentry command line client for some generic tasks. Right now this is
 primarily used to upload debug symbols to Sentry if you are not using the
-fastlane tools.
+Fastlane tools.
 
 * Downloads can be found under
   [Releases](https://github.com/getsentry/sentry-cli/releases/)
@@ -20,13 +25,34 @@ fastlane tools.
 
 ## Installation
 
-The recommended way to install is with everybody's favorite curl to bash:
+If you are on OS X or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:
 
     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:
+
+    curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION=2.0.4 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.
+
+If you are using `sentry-cli` on Windows environments, [Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist) is required.
+
+To verify it’s installed correctly you can bring up the help:
+
+    sentry-cli --help
+
+### pip
+
+_New in 2.14.3_: `sentry-cli` can also be installed using `pip`:
+
+```bash
+pip install sentry-cli
+```
+
 ### Node
 
-Additionally you can also install this binary via npm:
+Additionally, you can also install this binary via npm:
 
     npm install @sentry/cli
 
@@ -51,14 +77,22 @@ Or add property into your `.npmrc` file (https://www.npmjs.org/doc/files/npmrc.h
 sentrycli_cdnurl=https://mymirror.local/path
 ```
 
-Another option is to use the environment variable `SENTRYCLI_CDNURL`.
+There are a few environment variables that you can provide to control the npm installation:
 
-```sh
-SENTRYCLI_CDNURL=https://mymirror.local/path npm install @sentry/cli
+```
+SENTRYCLI_CDNURL=<url> # Use alternative cdn url for downloading binary
+SENTRYCLI_USE_LOCAL=1 # Use local instance of sentry-cli binary (looked up via $PATH environment)
+SENTRYCLI_SKIP_DOWNLOAD=1 # Skip downloading binary entirely
+SENTRYCLI_NO_PROGRESS_BAR=1 # Do not print the progress bar when downloading binary (default for non-TTY environments like CI)
+SENTRYCLI_LOG_STREAM=<stdout|stderr> # Changes where to redirect install script output
 ```
 
+When using `sentry-cli` via JavaScript API or any 3rd party plugin that is consuming said API,
+you can also use `SENTRY_BINARY_PATH=<path>` alongside `SENTRYCLI_SKIP_DOWNLOAD=1` to completely
+control what binaries are downloaded and used throughout the whole process.
+
 If you're installing the CLI with NPM from behind a proxy, the install script will
-use either NPM's configured HTTPS proxy server, or the value from your `HTTPS_PROXY`
+use either NPM's configured HTTPS proxy server or the value from your `HTTPS_PROXY`
 environment variable.
 
 ### Homebrew
@@ -79,6 +113,23 @@ docker pull getsentry/sentry-cli
 docker run --rm -v $(pwd):/work getsentry/sentry-cli --help
 ```
 
+Starting version _`2.8.0`_, in case you see `"error: config value 'safe.directory' was not found;"` message,
+you also need to correctly set UID and GID of mounted volumes like so:
+
+```sh
+docker run --rm -u "$(id -u):$(id -g)" -v $(pwd):/work getsentry/sentry-cli --help
+```
+
+This is required due to security issue in older `git` implementations. See [here](https://github.blog/2022-04-12-git-security-vulnerability-announced/) for more details.
+
+## Update
+
+To update sentry-cli to the latest version run:
+
+```sh
+sentry-cli update
+```
+
 ## Compiling
 
 In case you want to compile this yourself, you need to install at minimum the

package/bin/sentry-cli

@@ -3,17 +3,17 @@
 'use strict';
 
 const childProcess = require('child_process');
-const cli = require('../js');
+const SentryCli = require('../js');
 
 const child = childProcess
-  .spawn(cli.getPath(), process.argv.slice(2), {
+  .spawn(SentryCli.getPath(), process.argv.slice(2), {
     stdio: 'inherit',
   })
-  .on('error', err => {
+  .on('error', (err) => {
     console.error(err); // eslint-disable-line no-console
     process.exit(1);
   })
-  .on('exit', code => process.exit(code));
+  .on('exit', (code) => process.exit(code));
 
 process.on('SIGTERM', () => child.kill('SIGTERM'));
 process.on('SIGINT', () => child.kill('SIGINT'));

package/checksums.txt

@@ -1,9 +1,9 @@
-sentry-cli-Darwin-arm64=aa8e7c19cf408673ea41ed379fa26e736a59352bf5d1b9dcb24a38cec35aac12
-sentry-cli-Darwin-universal=17fa02c091c66dfd35e22766986d24176e3d95e3535bf957eb06478fbb9421e8
-sentry-cli-Darwin-x86_64=4c5c61be273f45d508a0a1a87618e595301ed1a996e334298380fe0d5c149825
-sentry-cli-Linux-aarch64=96c04befc82ae68c275aecf433f4b354f2f153318ab4585612f330e85eccd679
-sentry-cli-Linux-armv7=0fe9e7c163bfe9285617cf05e33c94830cc2fe3353114910e0f8fb4c70aa3079
-sentry-cli-Linux-i686=5f0f2b8e08b78d18f1173b96aeb98bc2a099f639481c80c4808ae4f1b4ea825a
-sentry-cli-Linux-x86_64=58f103859e57435dac7672db75b471a091de8e65e3c8776978cdf5a752d1fccd
-sentry-cli-Windows-i686.exe=abc8d4e1a06599b4d511ec530b8bfc3d21261410e5099b1813f74053bedac4a4
-sentry-cli-Windows-x86_64.exe=ae44f7464d91c2f8effa03a08ddeaefaaf5c2e9725213fc17b71317515027b79
+sentry-cli-Darwin-arm64=18c1972b79aeaeacb86a512076f355a7a1fd0cf7c0830d41e99ac579f12d6533
+sentry-cli-Darwin-universal=56973c245b5288de36d3fcb3420d67dc7f04e26c2c1cd35379ce617491f1d837
+sentry-cli-Darwin-x86_64=e60f59132433c1ec50e8570766a644a1abcf0e6fdf1f2bcca6de852daa260b62
+sentry-cli-Linux-aarch64=629e731a9dd2e925934eeab5e33f02ba2b60e8c2224b95321ab117a775ed6861
+sentry-cli-Linux-armv7=a8fbf4543d42372743ee8bc0ea7b43cb60b78d3e260d355ad4855c3bacf53f5c
+sentry-cli-Linux-i686=9b8982a2ebec0ba0b6199e070362f26e916e79e7d923cf2615f0af85afd1171b
+sentry-cli-Linux-x86_64=55fe5bdd1112bd6ff625df8cf97aca3e61df52293ab5b7d8f7466f334298bb27
+sentry-cli-Windows-i686.exe=fd53c35331d6208d9c1a2bdfc156235dcabb841c66162070470946215d4d79dd
+sentry-cli-Windows-x86_64.exe=e40cf0bde9c64f9e1f9936350b80e2e14708bca7744ecba0494d489c1ad56eba

package/js/helper.js

@@ -12,6 +12,10 @@ const childProcess = require('child_process');
  * @returns {string} The path to the sentry-cli binary
  */
 function getBinaryPath() {
+  if (process.env.SENTRY_BINARY_PATH) {
+    return process.env.SENTRY_BINARY_PATH;
+  }
+
   const parts = [];
   parts.push(__dirname);
   parts.push('..');
@@ -61,7 +65,7 @@ function mockBinaryPath(mockPath) {
 function serializeOptions(schema, options) {
   return Object.keys(schema).reduce((newOptions, option) => {
     const paramValue = options[option];
-    if (paramValue === undefined) {
+    if (paramValue === undefined || paramValue === null) {
       return newOptions;
     }
 
@@ -144,7 +148,7 @@ function getPath() {
  * @param {Object} [config] More configuration to pass to the CLI
  * @returns {Promise.<string>} A promise that resolves to the standard output.
  */
-function execute(args, live, silent, configFile, config = {}) {
+async function execute(args, live, silent, configFile, config = {}) {
   const env = { ...process.env };
   if (configFile) {
     env.SENTRY_PROPERTIES = configFile;
@@ -172,6 +176,12 @@ function execute(args, live, silent, configFile, config = {}) {
   }
   if (config.customHeader) {
     env.CUSTOM_HEADER = config.customHeader;
+  } else if (config.headers) {
+    const headers = Object.entries(config.headers).flatMap(([key, value]) => [
+      '--header',
+      `${key}:${value}`,
+    ]);
+    args = [...headers, ...args];
   }
   return new Promise((resolve, reject) => {
     if (live === true) {

package/js/index.d.ts

@@ -38,11 +38,6 @@ declare module '@sentry/cli' {
      * This value will update `SENTRY_VCS_REMOTE` env variable.
      */
     vcsRemote?: string;
-    /**
-     * Unique identifier for the distribution, used to further segment your release.
-     * Usually your build number.
-     */
-    dist?: string;
     /**
      * If true, all logs are suppressed.
      */
@@ -52,6 +47,11 @@ declare module '@sentry/cli' {
      * This value will update `CUSTOM_HEADER` env variable.
      */
     customHeader?: string;
+    /**
+     * Headers added to every outgoing network request.
+     * This value does not set any env variable, and is overridden by `customHeader`.
+     */
+    headers?: Record<string, string>;
   }
 
   /**
@@ -59,7 +59,9 @@ declare module '@sentry/cli' {
    * case `paths` takes the place of `include` in the options so as to make it
    * clear that this is not recursive.
    */
-  export type SourceMapsPathDescriptor = Omit<SentryCliUploadSourceMapsOptions, 'include'> & { paths: string[] }
+  export type SourceMapsPathDescriptor = Omit<SentryCliUploadSourceMapsOptions, 'include'> & {
+    paths: string[];
+  };
 
   export interface SentryCliUploadSourceMapsOptions {
     /**
@@ -85,6 +87,15 @@ declare module '@sentry/cli' {
      * This prevents the automatic detection of sourcemap references.
      */
     sourceMapReference?: boolean;
+    /**
+     * Enables files gzip decompression prior to uploading. Defaults to `false`.
+     */
+    decompress?: boolean;
+    /**
+     * Enable artifacts deduplication prior to uploading. This will skip uploading
+     * any artifacts that are already present on the server. Defaults to `true`.
+     */
+    dedupe?: boolean;
     /**
      * When paired with the rewrite option this will remove a prefix from uploaded files.
      * For instance you can use this to remove a path that is build machine specific.
@@ -116,6 +127,15 @@ declare module '@sentry/cli' {
      * By default the following file extensions are processed: js, map, jsbundle and bundle.
      */
     ext?: string[];
+    /**
+     * Unique identifier for the distribution, used to further segment your release.
+     * Usually your build number.
+     */
+    dist?: string;
+    /**
+     * Use new Artifact Bundles upload, that enables use of Debug ID for Source Maps discovery.
+     */
+    useArtifactBundle?: boolean;
   }
 
   export interface SentryCliNewDeployOptions {
@@ -176,31 +196,19 @@ declare module '@sentry/cli' {
   }
 
   export interface SentryCliReleases {
-    ['new'](
-      release: string,
-      options?: { projects: string[] } | string[]
-    ): Promise<string>;
+    ['new'](release: string, options?: { projects: string[] } | string[]): Promise<string>;
 
-    setCommits(
-      release: string,
-      options: SentryCliCommitsOptions
-    ): Promise<string>;
+    setCommits(release: string, options: SentryCliCommitsOptions): Promise<string>;
 
-    finalize(release: string): Promise<string>
+    finalize(release: string): Promise<string>;
 
-    proposeVersion(): Promise<string>
+    proposeVersion(): Promise<string>;
 
-    uploadSourceMaps(
-      release: string,
-      options: SentryCliUploadSourceMapsOptions
-    ): Promise<string>
+    uploadSourceMaps(release: string, options: SentryCliUploadSourceMapsOptions): Promise<string>;
 
     listDeploys(release: string): Promise<string>;
 
-    newDeploy(
-      release: string,
-      options: SentryCliNewDeployOptions
-    ): Promise<string>
+    newDeploy(release: string, options: SentryCliNewDeployOptions): Promise<string>;
 
     execute(args: string[], live: boolean): Promise<string>;
   }
@@ -214,14 +222,14 @@ declare module '@sentry/cli' {
      * This value will update `SENTRY_PROPERTIES` env variable.
      * @param options {@link SentryCliOptions}
      */
-    constructor(configFile?: string | null, options?: SentryCliOptions)
+    constructor(configFile?: string | null, options?: SentryCliOptions);
 
     public configFile?: string;
     public options?: SentryCliOptions;
-    public releases: SentryCliReleases
+    public releases: SentryCliReleases;
 
-    public static getVersion(): string
-    public static getPath(): string
-    public execute(args: string[], live: boolean): Promise<string>
+    public static getVersion(): string;
+    public static getPath(): string;
+    public execute(args: string[], live: boolean): Promise<string>;
   }
 }

package/js/releases/index.js

@@ -50,7 +50,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the release has been created.
    * @memberof SentryReleases
    */
-  new(release, options) {
+  async new(release, options) {
     const args = ['releases', 'new', release].concat(helper.getProjectFlagsFromOptions(options));
     return this.execute(args, null);
   }
@@ -76,7 +76,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the commits have been associated
    * @memberof SentryReleases
    */
-  setCommits(release, options) {
+  async setCommits(release, options) {
     if (!options || (!options.auto && (!options.repo || !options.commit))) {
       throw new Error('options.auto, or options.repo and options.commit must be specified');
     }
@@ -95,10 +95,6 @@ class Releases {
       commitFlags.push('--ignore-missing');
     }
 
-    if (options.ignoreEmpty) {
-      commitFlags.push('--ignore-empty');
-    }
-
     return this.execute(['releases', 'set-commits', release].concat(commitFlags));
   }
 
@@ -110,7 +106,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the release has been finalized.
    * @memberof SentryReleases
    */
-  finalize(release) {
+  async finalize(release) {
     return this.execute(['releases', 'finalize', release], null);
   }
 
@@ -121,10 +117,9 @@ class Releases {
    * @returns {Promise.<string>} A promise that resolves to the version string.
    * @memberof SentryReleases
    */
-  proposeVersion() {
-    return this.execute(['releases', 'propose-version'], null).then(
-      version => version && version.trim()
-    );
+  async proposeVersion() {
+    const version = await this.execute(['releases', 'propose-version'], null);
+    return version.trim();
   }
 
   /**
@@ -145,13 +140,15 @@ class Releases {
    *   ignoreFile: null,          // path to a file with ignore rules
    *   rewrite: false,            // preprocess sourcemaps before uploading
    *   sourceMapReference: true,  // add a source map reference to source files
+   *   dedupe: true,              // deduplicate already uploaded files
    *   stripPrefix: [],           // remove certain prefices from filenames
    *   stripCommonPrefix: false,  // guess common prefices to remove from filenames
    *   validate: false,           // validate source maps and cancel the upload on error
    *   urlPrefix: '',             // add a prefix source map urls after stripping them
    *   urlSuffix: '',             // add a suffix source map urls after stripping them
    *   ext: ['js', 'map', 'jsbundle', 'bundle'],  // override file extensions to scan for
-   *   projects: ['node']        // provide a list of projects
+   *   projects: ['node'],        // provide a list of projects
+   *   decompress: false          // decompress gzip files before uploading
    * });
    *
    * @param {string} release Unique name of the release.
@@ -159,7 +156,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the upload has completed successfully.
    * @memberof SentryReleases
    */
-  uploadSourceMaps(release, options) {
+  async uploadSourceMaps(release, options) {
     if (!options || !options.include || !Array.isArray(options.include)) {
       throw new Error(
         '`options.include` must be a vaild array of paths and/or path descriptor objects.'
@@ -169,7 +166,7 @@ class Releases {
     // Each entry in the `include` array will map to an array of promises, which
     // will in turn contain one promise per literal path value. Thus `uploads`
     // will be an array of Promise arrays, which we'll flatten later.
-    const uploads = options.include.map(includeEntry => {
+    const uploads = options.include.map((includeEntry) => {
       let pathOptions;
       let uploadPaths;
 
@@ -200,7 +197,7 @@ class Releases {
         .concat(helper.getProjectFlagsFromOptions(options))
         .concat(['files', release, 'upload-sourcemaps']);
 
-      return uploadPaths.map(path =>
+      return uploadPaths.map((path) =>
         // `execute()` is async and thus we're returning a promise here
         this.execute(helper.prepareCommand([...args, path], SOURCEMAPS_SCHEMA, newOptions), true)
       );
@@ -221,7 +218,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the list comes back from the server.
    * @memberof SentryReleases
    */
-  listDeploys(release) {
+  async listDeploys(release) {
     return this.execute(['releases', 'deploys', release, 'list'], null);
   }
 
@@ -247,7 +244,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the deploy has been created.
    * @memberof SentryReleases
    */
-  newDeploy(release, options) {
+  async newDeploy(release, options) {
     if (!options || !options.env) {
       throw new Error('options.env must be a vaild name');
     }
@@ -261,7 +258,7 @@ class Releases {
    * @param {boolean} live We inherit stdio to display `sentry-cli` output directly.
    * @returns {Promise.<string>} A promise that resolves to the standard output.
    */
-  execute(args, live) {
+  async execute(args, live) {
     return helper.execute(args, live, this.options.silent, this.configFile, this.options);
   }
 }

package/js/releases/options/uploadSourcemaps.js

@@ -11,6 +11,10 @@ module.exports = {
     param: '--dist',
     type: 'string',
   },
+  decompress: {
+    param: '--decompress',
+    type: 'boolean',
+  },
   rewrite: {
     param: '--rewrite',
     invertedParam: '--no-rewrite',
@@ -20,6 +24,10 @@ module.exports = {
     invertedParam: '--no-sourcemap-reference',
     type: 'boolean',
   },
+  dedupe: {
+    invertedParam: '--no-dedupe',
+    type: 'boolean',
+  },
   stripPrefix: {
     param: '--strip-prefix',
     type: 'array',
@@ -44,4 +52,8 @@ module.exports = {
     param: '--ext',
     type: 'array',
   },
+  useArtifactBundle: {
+    param: '--use-artifact-bundle',
+    type: 'boolean',
+  },
 };

package/package.json

@@ -1,28 +1,34 @@
 {
   "name": "@sentry/cli",
-  "version": "1.75.2",
+  "version": "1.77.0",
   "description": "A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/cli/",
+  "repository": "git://github.com/getsentry/sentry-cli.git",
   "homepage": "https://docs.sentry.io/hosted/learn/cli/",
+  "author": "Sentry",
   "license": "BSD-3-Clause",
-  "keywords": [
-    "sentry",
-    "sentry-cli",
-    "cli"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/getsentry/sentry-cli"
-  },
-  "bugs": {
-    "url": "https://github.com/getsentry/sentry-cli/issues"
-  },
   "engines": {
-    "node": ">= 8"
+    "node": ">= 10"
   },
   "main": "js/index.js",
+  "types": "js/index.d.ts",
   "bin": {
     "sentry-cli": "bin/sentry-cli"
   },
+  "dependencies": {
+    "https-proxy-agent": "^5.0.0",
+    "node-fetch": "^2.6.7",
+    "progress": "^2.0.3",
+    "proxy-from-env": "^1.1.0",
+    "which": "^2.0.2"
+  },
+  "devDependencies": {
+    "@vercel/nft": "^0.22.1",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.5.0",
+    "jest": "^27.5.1",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.6.2"
+  },
   "scripts": {
     "install": "node ./scripts/install.js",
     "fix": "npm-run-all fix:eslint fix:prettier",
@@ -35,29 +41,11 @@
     "test:prettier": "prettier --check  bin/* scripts/**/*.js js/**/*.js",
     "test:vercel-nft": "node scripts/test-vercel-nft.js"
   },
-  "dependencies": {
-    "https-proxy-agent": "^5.0.0",
-    "mkdirp": "^0.5.5",
-    "node-fetch": "^2.6.7",
-    "progress": "^2.0.3",
-    "proxy-from-env": "^1.1.0",
-    "which": "^2.0.2"
-  },
-  "devDependencies": {
-    "@vercel/nft": "^0.22.1",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.1.0",
-    "eslint-config-prettier": "^6.10.1",
-    "eslint-plugin-import": "^2.20.2",
-    "jest": "^25.3.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^1.19.1"
-  },
   "jest": {
     "collectCoverage": true,
     "testEnvironment": "node",
     "testPathIgnorePatterns": [
-      "src/utils"
+      "<rootDir>/src"
     ]
   },
   "volta": {

package/scripts/build-in-docker.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -eux
 
-DOCKER_IMAGE="getsentry/rust-musl-cross:${DOCKER_TAG}"
+DOCKER_IMAGE="messense/rust-musl-cross:${DOCKER_TAG}"
 BUILD_DIR="/work"
 
 DOCKER_RUN_OPTS="
@@ -9,7 +9,6 @@ DOCKER_RUN_OPTS="
   -v $(pwd):${BUILD_DIR}:ro
   -v $(pwd)/target:${BUILD_DIR}/target
   -v $HOME/.cargo/registry:/root/.cargo/registry
-  -e ARMV7_UNKNOWN_LINUX_MUSLEABI_OPENSSL_NO_VENDOR=1
   ${DOCKER_IMAGE}
 "