From b46ac7759e86290f7fe5c20b98e4b327fc997d56 Mon Sep 17 00:00:00 2001 From: Andrei Borza Date: Tue, 21 Jan 2025 15:10:16 +0100 Subject: [PATCH 1/4] ref(docs): Update README with more info on prerequisites --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b7b6c8af..1ad7a000 100644 --- a/README.md +++ b/README.md @@ -31,18 +31,29 @@ Additionally, releases are used for applying [source maps](https://docs.sentry.i A new option to inject Debug IDs into source files and sourcemaps was added to the action to ensure proper un-minifaction of your stacktraces. We **strongly recommend enabling** this by setting `inject: true` in your action alongside providing a path to sourcemaps. +[Learn more about debug ids](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) + Please refer to the [release page](https://github.com/getsentry/action-release/releases) for the latest release notes. -[Learn more about debug ids](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) ## Prerequisites ### Create an Organization Auth Token -> [!NOTE] -> You have to be an admin in your Sentry org to create this. - For this action to communicate securely with Sentry, you'll need to [create an organization auth token](https://docs.sentry.io/account/auth-tokens/#organization-auth-tokens). -Copy the generated token and use it as your `SENTRY_AUTH_TOKEN`. We recommend storing it as an [encrypted secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions). + +Alternatively, you can also use a [User Auth Token](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens), with the "Project: Read & Write" and "Release: Admin" permissions. + +You also need to set your Organization and Project slugs and if you're using a self-hosted Sentry instance, provide the URL used to connect to Sentry via SENTRY_URL. + +```bash +SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE +SENTRY_ORG=example-org +SENTRY_PROJECT=example-project +# For self-hosted +# SENTRY_URL=https://my-sentry-url +``` + +We recommend storing these as [encrypted secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) on your repository. ## Usage From 84598a295eb396a62f7a9ae451051a6dfd5f30ab Mon Sep 17 00:00:00 2001 From: Andrei <168741329+andreiborza@users.noreply.github.com> Date: Tue, 21 Jan 2025 15:42:32 +0100 Subject: [PATCH 2/4] Update README.md Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 1ad7a000..4809c4ed 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,6 @@ Please refer to the [release page](https://github.com/getsentry/action-release/r For this action to communicate securely with Sentry, you'll need to [create an organization auth token](https://docs.sentry.io/account/auth-tokens/#organization-auth-tokens). -Alternatively, you can also use a [User Auth Token](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens), with the "Project: Read & Write" and "Release: Admin" permissions. You also need to set your Organization and Project slugs and if you're using a self-hosted Sentry instance, provide the URL used to connect to Sentry via SENTRY_URL. From 396f04046b8cc8b49def543adc068296d7d6faa7 Mon Sep 17 00:00:00 2001 From: Andrei <168741329+andreiborza@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:10:27 +0100 Subject: [PATCH 3/4] Update README.md Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4809c4ed..1f16c512 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Additionally, releases are used for applying [source maps](https://docs.sentry.i * **feat(sourcemaps): Add inject option to inject debug ids into source files and sourcemaps** -A new option to inject Debug IDs into source files and sourcemaps was added to the action to ensure proper un-minifaction of your stacktraces. We **strongly recommend enabling** this by setting `inject: true` in your action alongside providing a path to sourcemaps. +A new option to inject [Debug IDs](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) into source files and sourcemaps was added to the action to ensure proper un-minifaction of your stacktraces. We **strongly recommend enabling** this by setting `inject: true` in your action alongside providing a path to sourcemaps. [Learn more about debug ids](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) From 553bb528875388ee4d7ce4e229ece33fd2758f8f Mon Sep 17 00:00:00 2001 From: Andrei <168741329+andreiborza@users.noreply.github.com> Date: Tue, 21 Jan 2025 16:10:36 +0100 Subject: [PATCH 4/4] Update README.md Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 1f16c512..a34ca8bd 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,6 @@ Additionally, releases are used for applying [source maps](https://docs.sentry.i A new option to inject [Debug IDs](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) into source files and sourcemaps was added to the action to ensure proper un-minifaction of your stacktraces. We **strongly recommend enabling** this by setting `inject: true` in your action alongside providing a path to sourcemaps. -[Learn more about debug ids](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) Please refer to the [release page](https://github.com/getsentry/action-release/releases) for the latest release notes.