feat(sourcemaps): Add inject option to inject debug ids into sourcefiles and sourcemaps

Author: andreiborza

README.md

@@ -60,23 +60,24 @@ Adding the following to your workflow will create a new Sentry release and tell
 
 #### Parameters
 
-|name|description|default|
-|---|---|---|
-|`environment`|Set the environment for this release. E.g. "production" or "staging". Omit to skip adding deploy to release.|-|
-|`finalize`|When false, omit marking the release as finalized and released.|`true`|
-|`ignore_missing`|When the flag is set and the previous release commit was not found in the repository, will create a release with the default commits count instead of failing the command.|`false`|
-|`ignore_empty`|When the flag is set, command will not fail and just exit silently if no new commits for a given release have been found.|`false`|
-|`sourcemaps`|Space-separated list of paths to JavaScript sourcemaps. Omit to skip uploading sourcemaps.|-|
-|`dist`|Unique identifier for the distribution, used to further segment your release. Usually your build number.|-|
-|`started_at`|Unix timestamp of the release start date. Omit for current time.|-|
-|`version`|Identifier that uniquely identifies the releases. _Note: the `refs/tags/` prefix is automatically stripped when `version` is `github.ref`._|<code>${{&nbsp;github.sha&nbsp;}}</code>|
-|`version_prefix`|Value prepended to auto-generated version. For example "v".|-|
-|`set_commits`|Specify whether to set commits for the release. Either "auto" or "skip".|"auto"|
-|`projects`|Space-separated list of paths of projects. When omitted, falls back to the environment variable `SENTRY_PROJECT` to determine the project.|-|
-|`url_prefix`|Adds a prefix to source map urls after stripping them.|-|
-|`strip_common_prefix`|Will remove a common prefix from uploaded filenames. Useful for removing a path that is build-machine-specific.|`false`|
-|`working_directory`|Directory to collect sentry release information from. Useful when collecting information from a non-standard checkout directory.|-|
-|`disable_telemetry`|The action sends telemetry data and crash reports to Sentry. This helps us improve the action. You can turn this off by setting this flag.|`false`|
+|name| description                                                                                                                                                                |default|
+|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
+|`environment`| Set the environment for this release. E.g. "production" or "staging". Omit to skip adding deploy to release.                                                               |-|
+|`inject`| Injects Debug IDs into source files and sourcemaps. We **strongly recommend** enabling this to ensure proper un-minifaction of your stacktraces.                           |`false`|
+|`sourcemaps`| Space-separated list of paths to JavaScript sourcemaps. Omit to skip uploading sourcemaps.                                                                                 |-|
+|`finalize`| When false, omit marking the release as finalized and released.                                                                                                            |`true`|
+|`ignore_missing`| When the flag is set and the previous release commit was not found in the repository, will create a release with the default commits count instead of failing the command. |`false`|
+|`ignore_empty`| When the flag is set, command will not fail and just exit silently if no new commits for a given release have been found.                                                  |`false`|
+|`dist`| Unique identifier for the distribution, used to further segment your release. Usually your build number.                                                                   |-|
+|`started_at`| Unix timestamp of the release start date. Omit for current time.                                                                                                           |-|
+|`version`| Identifier that uniquely identifies the releases. _Note: the `refs/tags/` prefix is automatically stripped when `version` is `github.ref`._                                |<code>${{&nbsp;github.sha&nbsp;}}</code>|
+|`version_prefix`| Value prepended to auto-generated version. For example "v".                                                                                                                |-|
+|`set_commits`| Specify whether to set commits for the release. Either "auto" or "skip".                                                                                                   |"auto"|
+|`projects`| Space-separated list of paths of projects. When omitted, falls back to the environment variable `SENTRY_PROJECT` to determine the project.                                 |-|
+|`url_prefix`| Adds a prefix to source map urls after stripping them.                                                                                                                     |-|
+|`strip_common_prefix`| Will remove a common prefix from uploaded filenames. Useful for removing a path that is build-machine-specific.                                                            |`false`|
+|`working_directory`| Directory to collect sentry release information from. Useful when collecting information from a non-standard checkout directory.                                           |-|
+|`disable_telemetry`| The action sends telemetry data and crash reports to Sentry. This helps us improve the action. You can turn this off by setting this flag.                                 |`false`|
 
 ### Examples
 

action.yml

@@ -5,6 +5,9 @@ inputs:
   environment:
     description: 'Set the environment for this release. E.g. "production" or "staging". Omit to skip adding deploy to release.'
     required: false
+  inject:
+    description: 'Injects Debug IDs into source files and sourcemaps. We strongly recommend enabling this to ensure proper un-minifaction of your stacktraces.'
+    required: false
   sourcemaps:
     description: 'Space-separated list of paths to JavaScript sourcemaps. Omit to skip uploading sourcemaps.'
     required: false

package.json

@@ -1,6 +1,6 @@
 {
   "name": "action-release",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "private": true,
   "description": "GitHub Action for creating a release on Sentry",
   "main": "dist/index.js",

src/main.ts

@@ -20,6 +20,7 @@ withTelemetry(
       options.checkEnvironmentVariables();
 
       const environment = options.getEnvironment();
+      const inject = options.getBooleanOption('inject', false);
       const sourcemaps = options.getSourcemaps();
       const dist = options.getDist();
       const shouldFinalize = options.getBooleanOption('finalize', true);
@@ -64,8 +65,20 @@ withTelemetry(
       }
 
       Sentry.setTag('sourcemaps', sourcemaps.length > 0);
+      Sentry.setTag('inject', inject);
 
       if (sourcemaps.length) {
+        if (inject) {
+          await traceStep('inject-debug-ids', async () => {
+            core.debug(`Injecting Debug IDs`);
+            // Unfortunately, @sentry/cli does not yet have an alias for inject
+            await getCLI().execute(
+              ['sourcemaps', 'inject', ...sourcemaps],
+              true
+            );
+          });
+        }
+
         await traceStep('upload-sourcemaps', async () => {
           core.debug(`Adding sourcemaps`);
           await Promise.all(