@sentry/cli 3.0.3 → 3.2.0

package/README.md

@@ -20,21 +20,25 @@ Please refer to [Sentry CLI's documentation page](https://docs.sentry.io/cli/).
 
 ## Compatibility
 
-Sentry CLI officially supports [Sentry SaaS](https://sentry.io/) and [Sentry Self-Hosted](https://github.com/getsentry/self-hosted) versions 25.11.1 and above.
+Sentry CLI officially supports [Sentry SaaS](https://sentry.io/) and [Sentry Self-Hosted](https://github.com/getsentry/self-hosted) versions 24.11.1 and above.
 
-### Self-Hosted Sentry
+<details>
 
-Although some Sentry CLI features may work with versions of Sentry Self-Hosted prior to 25.11.1, we recommend users upgrade their self-hosted installations to a compatible version.
+<summary><h3>Self-Hosted Sentry</h3></summary>
 
-For users who cannot upgrade their self-hosted installation, we recommend using the latest compatible Sentry CLI version, per the table below:
+For self-hosted installations, only those features which were available in Sentry CLI at the time of the release of the given self-hosted version are supported, as new features may require server-side support. Additionally, some features, like the `sentry-cli build` commands, are restricted to Sentry SaaS.
+
+Users who are using Sentry Self-Hosted versions older than 24.11.1 are encouraged to upgrade their Sentry Self-Hosted installations before using Sentry CLI versions 3.0.0 and above. For users who cannot upgrade, please use the version indicated in the table below.
 
 | **Sentry Self-Hosted Version** | **Newest Compatible Sentry CLI Version**                              |
 | ------------------------------ | --------------------------------------------------------------------- |
-| ≥ 25.11.1                      | [latest](https://github.com/getsentry/sentry-cli/releases/latest)     |
-| < 25.11.1                      | [2.58.4](https://github.com/getsentry/sentry-cli/releases/tag/2.58.4) |
+| ≥ 24.11.1                      | [latest](https://github.com/getsentry/sentry-cli/releases/latest)     |
+| < 24.11.1                      | [2.58.4](https://github.com/getsentry/sentry-cli/releases/tag/2.58.4) |
 
 Note that we can only provide support for officially-supported Sentry Self-Hosted versions. We will not backport fixes for older Sentry CLI versions, even if they should be compatible with your self-hosted version.
 
+</details>
+
 ## Versioning
 
 Sentry CLI follows semantic versioning, according to [this versioning policy](VERSIONING.md).
@@ -58,3 +62,7 @@ Also, there is a Dockerfile that builds an Alpine-based Docker image with
 docker build -t sentry-cli .
 docker run --rm -v $(pwd):/work sentry-cli --help
 ```
+
+## Internal docs
+
+Snapshot: [Sentry CLI distribution as of 2026-01-29](docs/snapshots/2026-01-29-sentry-cli-distribution.md).

package/checksums.txt

@@ -1,10 +1,10 @@
-sentry-cli-Darwin-arm64=4a67813a0945ee87de3bfbf62faf596a8e6374b7d4ca9ee1b067a4b725d61dc6
-sentry-cli-Darwin-universal=de726ed1b4efd7c3a2b35481fbc80213c24696b00f476d001d52b8eab87c4d38
-sentry-cli-Darwin-x86_64=9560c0994e5e3cda856345cd22ae05815c9a5a0f8c650ecdc2487559098f6f3a
-sentry-cli-Linux-aarch64=2617026dcaa0c9fc413bf0cbd83d0e2ac9dc75b3adbb4de8128ba1e2723fef46
-sentry-cli-Linux-armv7=b14004c1de1c2c19f51972547b3588cac1a332558d55a89baa5becb218de738f
-sentry-cli-Linux-i686=ae73f0edff817f1e71614305ef666199fb3b46f8d7cb890a08654e9d03fef923
-sentry-cli-Linux-x86_64=0dba6a25c7d2aa22d4140e65e5652214e4a8dfb2dc3463ab87359abe06c21272
-sentry-cli-Windows-aarch64.exe=f43f57d345e5e56a36faa7632f5bac10174426d1e402f1664ec2b5f9c2740809
-sentry-cli-Windows-i686.exe=468fa7d37b5dc43c9f4ec61ea5ea5f9ada5a44bd7bbcfdb37828bfc5b2517fe3
-sentry-cli-Windows-x86_64.exe=e74d54955197307baf88b6dca37b39cf3dd1156c116421ce424162daaaed8cb2
+sentry-cli-Darwin-arm64=17802017c1a0d76751b4bfdddea4366a84d19e790de86e9675e09f2d4cf9cefd
+sentry-cli-Darwin-universal=a18195af49db6ea455a0d785b5bd392fb8df6f2eaf0078528c6b4653b4ce5799
+sentry-cli-Darwin-x86_64=4018f4162b2f160c01b082d64ac36cce069c81e71a1bae3707324b3d90634415
+sentry-cli-Linux-aarch64=e92b176153f3729b2b4b0d41b9b523df6ebbd49378b45fbbc008052042460f96
+sentry-cli-Linux-armv7=9cde058201958bc53c1ba4deb67fcb76970084522cd5e980ea16791b21757c31
+sentry-cli-Linux-i686=5e08f47c358ee6592bea2a6854a722d7a5512c879e7a0440897e882fdb5b496c
+sentry-cli-Linux-x86_64=cb82525102b8ad9a300bfb55afa3dc2d9ab275caf1dcbfdf431fc11fdf13136f
+sentry-cli-Windows-aarch64.exe=6b88b9e618a00f2f8dd743fb8a44ab250de34fca07e178c2fa36a7d42fce513f
+sentry-cli-Windows-i686.exe=034c756e27768b872ae1bdec1eb3edfb32ec3f7d7576e7373a45ec0784e067ee
+sentry-cli-Windows-x86_64.exe=a417276f00f895659dfa21d0f0e847e056eccf2a457939ccd83424bf99174604

package/js/index.d.ts

@@ -1,6 +1,7 @@
 import { Releases } from './releases';
+import { SourceMaps } from './sourceMaps';
 import type { SentryCliOptions } from './types';
-export type { SentryCliOptions, SentryCliUploadSourceMapsOptions, SourceMapsPathDescriptor, SentryCliNewDeployOptions, SentryCliCommitsOptions, } from './types';
+export type { SentryCliOptions, SentryCliUploadSourceMapsOptions, SourceMapsPathDescriptor, SentryCliNewDeployOptions, SentryCliCommitsOptions, SentryCliInjectOptions, } from './types';
 /**
  * Interface to and wrapper around the `sentry-cli` executable.
  *
@@ -20,6 +21,7 @@ export declare class SentryCli {
     configFile: string | null;
     options: SentryCliOptions;
     releases: Releases;
+    sourceMaps: SourceMaps;
     /**
      * Creates a new `SentryCli` instance.
      *

package/js/index.js

@@ -4,6 +4,7 @@ exports.SentryCli = void 0;
 const pkgInfo = require("../package.json");
 const helper = require("./helper");
 const releases_1 = require("./releases");
+const sourceMaps_1 = require("./sourceMaps");
 /**
  * Interface to and wrapper around the `sentry-cli` executable.
  *
@@ -40,6 +41,7 @@ class SentryCli {
         }
         this.options = options || { silent: false };
         this.releases = new releases_1.Releases(this.options, configFile);
+        this.sourceMaps = new sourceMaps_1.SourceMaps(this.options, configFile);
     }
     /**
      * Returns the version of the installed `sentry-cli` binary.

package/js/releases/index.d.ts

@@ -98,6 +98,7 @@ export declare class Releases {
      *   time: 1295,                 // deployment duration in seconds. This can be specified alternatively to `started` and `finished`
      *   name: 'PickleRick',         // human readable name for this deployment
      *   url: 'https://example.com', // URL that points to the deployment
+     *   projects: ['project1', 'project2'], // list of projects to deploy to
      * });
      *
      * @param release Unique name of the release.

package/js/releases/index.js

@@ -126,6 +126,7 @@ class Releases {
      * @param options Options to configure the source map upload.
      * @returns A promise that resolves when the upload has completed successfully.
      */
+    // TODO: Add `uploadSourceMaps()` to SourceMaps class as `.upload()` (keep it here too for backward compatibility)
     uploadSourceMaps(release, options) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!options || !options.include || !Array.isArray(options.include)) {
@@ -196,6 +197,7 @@ class Releases {
      *   time: 1295,                 // deployment duration in seconds. This can be specified alternatively to `started` and `finished`
      *   name: 'PickleRick',         // human readable name for this deployment
      *   url: 'https://example.com', // URL that points to the deployment
+     *   projects: ['project1', 'project2'], // list of projects to deploy to
      * });
      *
      * @param release Unique name of the release.
@@ -207,7 +209,9 @@ class Releases {
             if (!options || !options.env) {
                 throw new Error('options.env must be a valid name');
             }
-            const args = ['releases', 'deploys', release, 'new'];
+            const args = ['deploys', 'new']
+                .concat(helper.getProjectFlagsFromOptions(options))
+                .concat(['--release', release]);
             return this.execute(helper.prepareCommand(args, deploys_1.DEPLOYS_OPTIONS, options), null);
         });
     }

package/js/sourceMaps/index.d.ts

@@ -0,0 +1,45 @@
+import { SentryCliInjectOptions, SentryCliOptions } from '../types';
+/**
+ * Manages source map operations on Sentry.
+ */
+export declare class SourceMaps {
+    options: SentryCliOptions;
+    private configFile;
+    constructor(options: SentryCliOptions, configFile: string | null);
+    /**
+     * Fixes up JavaScript source files and source maps with debug ids.
+     *
+     * For every minified JS source file, a debug id is generated and
+     * inserted into the file. If the source file references a
+     * source map and that source map is locally available,
+     * the debug id will be injected into it as well.
+     * If the referenced source map already contains a debug id,
+     * that id is used instead.
+     *
+     * @example
+     * await cli.sourceMaps.inject({
+     *   // required options:
+     *   paths: ['./dist'],
+     *
+     *   // default options:
+     *   ignore: ['node_modules'],  // globs for files to ignore
+     *   ignoreFile: null,          // path to a file with ignore rules
+     *   ext: ['js', 'cjs', 'mjs'], // file extensions to consider
+     *   dryRun: false,             // don't modify files on disk
+     * });
+     *
+     * @param options Options to configure the debug id injection.
+     * @returns A promise that resolves when the injection has completed successfully.
+     */
+    inject(options: SentryCliInjectOptions): Promise<string>;
+    /**
+     * See {helper.execute} docs.
+     * @param args Command line arguments passed to `sentry-cli`.
+     * @param live can be set to:
+     *  - `true` to inherit stdio and reject the promise if the command
+     *    exits with a non-zero exit code.
+     *  - `false` to not inherit stdio and return the output as a string.
+     * @returns A promise that resolves to the standard output.
+     */
+    execute(args: string[], live: boolean): Promise<string>;
+}

package/js/sourceMaps/index.js

@@ -0,0 +1,83 @@
+'use strict';
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SourceMaps = void 0;
+const inject_1 = require("./options/inject");
+const helper = require("../helper");
+/**
+ * Default arguments for the `--ignore` option.
+ */
+const DEFAULT_IGNORE = ['node_modules'];
+/**
+ * Manages source map operations on Sentry.
+ */
+class SourceMaps {
+    constructor(options = {}, configFile) {
+        this.options = options;
+        this.configFile = configFile;
+    }
+    /**
+     * Fixes up JavaScript source files and source maps with debug ids.
+     *
+     * For every minified JS source file, a debug id is generated and
+     * inserted into the file. If the source file references a
+     * source map and that source map is locally available,
+     * the debug id will be injected into it as well.
+     * If the referenced source map already contains a debug id,
+     * that id is used instead.
+     *
+     * @example
+     * await cli.sourceMaps.inject({
+     *   // required options:
+     *   paths: ['./dist'],
+     *
+     *   // default options:
+     *   ignore: ['node_modules'],  // globs for files to ignore
+     *   ignoreFile: null,          // path to a file with ignore rules
+     *   ext: ['js', 'cjs', 'mjs'], // file extensions to consider
+     *   dryRun: false,             // don't modify files on disk
+     * });
+     *
+     * @param options Options to configure the debug id injection.
+     * @returns A promise that resolves when the injection has completed successfully.
+     */
+    inject(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!options || !options.paths || !Array.isArray(options.paths)) {
+                throw new Error('`options.paths` must be a valid array of paths.');
+            }
+            if (options.paths.length === 0) {
+                throw new Error('`options.paths` must contain at least one path.');
+            }
+            const newOptions = Object.assign({}, options);
+            if (!newOptions.ignoreFile && !newOptions.ignore) {
+                newOptions.ignore = DEFAULT_IGNORE;
+            }
+            const args = helper.prepareCommand(['sourcemaps', 'inject', ...options.paths], inject_1.INJECT_OPTIONS, newOptions);
+            return this.execute(args, true);
+        });
+    }
+    /**
+     * See {helper.execute} docs.
+     * @param args Command line arguments passed to `sentry-cli`.
+     * @param live can be set to:
+     *  - `true` to inherit stdio and reject the promise if the command
+     *    exits with a non-zero exit code.
+     *  - `false` to not inherit stdio and return the output as a string.
+     * @returns A promise that resolves to the standard output.
+     */
+    execute(args, live) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return helper.execute(args, live, this.options.silent, this.configFile, this.options);
+        });
+    }
+}
+exports.SourceMaps = SourceMaps;

package/js/sourceMaps/options/inject.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Schema for the `sourcemaps inject` command.
+ */
+export declare const INJECT_OPTIONS: {
+    ignore: {
+        param: string;
+        type: "array";
+    };
+    ignoreFile: {
+        param: string;
+        type: "string";
+    };
+    ext: {
+        param: string;
+        type: "array";
+    };
+    dryRun: {
+        param: string;
+        type: "boolean";
+    };
+};

package/js/sourceMaps/options/inject.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INJECT_OPTIONS = void 0;
+/**
+ * Schema for the `sourcemaps inject` command.
+ */
+exports.INJECT_OPTIONS = {
+    ignore: {
+        param: '--ignore',
+        type: 'array',
+    },
+    ignoreFile: {
+        param: '--ignore-file',
+        type: 'string',
+    },
+    ext: {
+        param: '--ext',
+        type: 'array',
+    },
+    dryRun: {
+        param: '--dry-run',
+        type: 'boolean',
+    },
+};

package/js/types.d.ts

@@ -163,6 +163,10 @@ export type SentryCliNewDeployOptions = {
      * URL that points to the deployment.
      */
     url?: string;
+    /**
+     * The projects to deploy the release to. If not provided, the deployment will be created for all projects associated with the release.
+     */
+    projects?: string[];
 };
 /**
  * Options for setting commits on a release
@@ -196,3 +200,31 @@ export type SentryCliCommitsOptions = {
      */
     ignoreEmpty?: boolean;
 };
+/**
+ * Options for injecting debug IDs into source files and source maps
+ */
+export type SentryCliInjectOptions = {
+    /**
+     * One or more paths that Sentry CLI should scan recursively for JavaScript source files.
+     */
+    paths: string[];
+    /**
+     * One or more paths to ignore during injection. Overrides entries in ignoreFile file.
+     * Defaults to ['node_modules'] if neither ignore nor ignoreFile is specified.
+     */
+    ignore?: string[];
+    /**
+     * Path to a file containing list of files/directories to ignore.
+     * Can point to .gitignore or anything with the same format.
+     */
+    ignoreFile?: string;
+    /**
+     * Set the file extensions of JavaScript files that are considered for injection.
+     * This overrides the default extensions (js, cjs, mjs).
+     */
+    ext?: string[];
+    /**
+     * Don't modify files on disk.
+     */
+    dryRun?: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/cli",
-  "version": "3.0.3",
+  "version": "3.2.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/",
@@ -22,7 +22,7 @@
   },
   "devDependencies": {
     "@types/node": "^20.10.0",
-    "@vercel/nft": "^0.22.1",
+    "@vercel/nft": "^1.2.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.5.0",
     "jest": "^27.5.1",
@@ -32,14 +32,14 @@
     "typescript": "5.8.3"
   },
   "optionalDependencies": {
-    "@sentry/cli-darwin": "3.0.3",
-    "@sentry/cli-linux-arm": "3.0.3",
-    "@sentry/cli-linux-arm64": "3.0.3",
-    "@sentry/cli-linux-i686": "3.0.3",
-    "@sentry/cli-linux-x64": "3.0.3",
-    "@sentry/cli-win32-i686": "3.0.3",
-    "@sentry/cli-win32-x64": "3.0.3",
-    "@sentry/cli-win32-arm64": "3.0.3"
+    "@sentry/cli-darwin": "3.2.0",
+    "@sentry/cli-linux-arm": "3.2.0",
+    "@sentry/cli-linux-arm64": "3.2.0",
+    "@sentry/cli-linux-i686": "3.2.0",
+    "@sentry/cli-linux-x64": "3.2.0",
+    "@sentry/cli-win32-i686": "3.2.0",
+    "@sentry/cli-win32-x64": "3.2.0",
+    "@sentry/cli-win32-arm64": "3.2.0"
   },
   "scripts": {
     "postinstall": "node ./scripts/install.js",