Skip to content

Commit 417d443

Browse files
ref(docs): Update README with more info on prerequisites (#234)
* ref(docs): Update README with more info on prerequisites * Update README.md Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> * Update README.md Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> * Update README.md Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com> --------- Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
1 parent f6dfa3d commit 417d443

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,29 @@ Additionally, releases are used for applying [source maps](https://docs.sentry.i
2929

3030
* **feat(sourcemaps): Add inject option to inject debug ids into source files and sourcemaps**
3131

32-
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.
32+
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.
33+
3334

3435
Please refer to the [release page](https://github.com/getsentry/action-release/releases) for the latest release notes.
3536

36-
[Learn more about debug ids](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/)
3737
## Prerequisites
3838

3939
### Create an Organization Auth Token
4040

41-
> [!NOTE]
42-
> You have to be an admin in your Sentry org to create this.
43-
4441
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).
45-
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).
42+
43+
44+
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.
45+
46+
```bash
47+
SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE
48+
SENTRY_ORG=example-org
49+
SENTRY_PROJECT=example-project
50+
# For self-hosted
51+
# SENTRY_URL=https://my-sentry-url
52+
```
53+
54+
We recommend storing these as [encrypted secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) on your repository.
4655

4756
## Usage
4857

0 commit comments

Comments
 (0)