Use org auth token in JS and Sentry CLI docs #7714

lforst · 2023-08-31T09:00:56Z

Updates the docs for JavaScript and Sentry CLI source maps upload to use org auth tokens when applicable.

Closes getsentry/team-webplatform-meta#62

vercel · 2023-08-31T09:00:58Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs	🛑 Canceled (Inspect)			Sep 1, 2023 10:46am

mydea · 2023-08-31T09:03:17Z

src/docs/product/cli/configuration.mdx

@@ -28,7 +28,7 @@ sentry-cli --url https://myserver.invalid/ login

 ## To authenticate manually:

-Visit your [auth token user settings page](https://sentry.io/settings/account/api/auth-tokens/) and create or copy an existing token. Then either:
+Visit the [Organization Auth Token Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) and create a new token or copy an existing one. Then either:


m: You can't copy an existing one anymore 😅 so:

Suggested change

Visit the [Organization Auth Token Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) and create a new token or copy an existing one. Then either:

Visit the [Organization Auth Token Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) and create a new token. Then either:

mydea · 2023-08-31T09:05:05Z

src/includes/sentry-cli-sourcemaps.mdx

+SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___
 SENTRY_ORG=___ORG_SLUG___
 SENTRY_PROJECT=___PROJECT_SLUG___


we should move always move this below the org/project slug, as in the UI they are kind of coupled together - selecting the org/project influences where you create the token for. So IMHO it is a better flow to always make this:

Suggested change

SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___

SENTRY_ORG=___ORG_SLUG___

SENTRY_PROJECT=___PROJECT_SLUG___

SENTRY_ORG=___ORG_SLUG___

SENTRY_PROJECT=___PROJECT_SLUG___

SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___

Co-authored-by: Francesco Novy <[email protected]>

mydea · 2023-08-31T09:05:55Z

src/includes/sentry-cli-sourcemaps.mdx

-Visit the [auth token user settings page](https://sentry.io/settings/account/api/auth-tokens/) to find your auth tokens.
-
-</Note>
+<OrgAuthTokenNote />

 <SignInNote />


Suggested change

<SignInNote />

OrgAuthTokenNote is kind of a more detailed version of SignInNote, so when we show this we can skip the sign in note!

The sign in note needs to come before every instance where we use ___ORG_SLUG___ or ___PROJECT_SLUG___.

They describe two different things

Hmm, I guess it's true... but - it's a bit weird to have two of these note boxes over each other that both show similar-but-not-quite-the-same info 🤔

What about just updating the not-signed-in test of the <OrgAuthTokenNote> from:

You can manually create an Auth Token or sign in to create a token directly from the docs.

to something like

You can manually create an Auth Token or sign in to create a token directly from the docs. Once you sign in, you will be able to select your personal config from a dropdown.

With #7716 we can make this all a bit more cleaner

src/includes/sourcemaps-create-react-app.mdx

src/platform-includes/sourcemaps/upload/webpack/javascript.mdx

mydea · 2023-08-31T09:08:11Z

src/platforms/javascript/guides/sveltekit/manual-setup.mdx

@@ -197,7 +197,7 @@ You can set them as environment variables, for example in a `.env` file:

 - `SENTRY_ORG` your Sentry org slug
 - `SENTRY_PROJECT` your Sentry project slug
- `SENTRY_AUTH_TOKEN` your Sentry auth token
+- `SENTRY_AUTH_TOKEN` your Sentry auth token (can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/)


Suggested change

- `SENTRY_AUTH_TOKEN` your Sentry auth token (can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/)

- `SENTRY_AUTH_TOKEN` your Sentry auth token (can be obtained from [your Organization Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/))

Maybe something like this? The link is kind of ugly...

lizokm

LGTM

src/docs/product/cli/configuration.mdx

src/docs/product/sentry-basics/integrate-frontend/configure-scms.mdx

src/platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx

src/platform-includes/sourcemaps/upload/vite/javascript.mdx

src/platform-includes/sourcemaps/upload/webpack/javascript.mdx

src/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx

src/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx

mydea · 2023-09-01T07:38:00Z

src/platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx

@@ -129,7 +129,7 @@ module.exports = {
      org: "___ORG_SLUG___",
      project: "___PROJECT_SLUG___",

-      // Auth tokens can be obtained from https://sentry.io/settings/account/api/auth-tokens/
+      // Auth tokens can be obtained from the your User Settings
      // and need `project:releases` and `org:read` scopes


Whats the reason we are not replacing this with org tokens here?

This is in the legacy docs. People here may use a self hosted version that is not yet compatible with org auth tokens.

ah, makes sense! 👍

mydea

great work!

Co-authored-by: Liza Mock <[email protected]>

Use org auth token in JS and Sentry CLI docs

951e49c

lforst requested review from mydea and Lms24 August 31, 2023 09:01

lforst self-assigned this Aug 31, 2023

mydea reviewed Aug 31, 2023

View reviewed changes

Update src/docs/product/cli/configuration.mdx

4fa848d

Co-authored-by: Francesco Novy <[email protected]>

mydea reviewed Aug 31, 2023

View reviewed changes

src/includes/sourcemaps-create-react-app.mdx Outdated Show resolved Hide resolved

mydea reviewed Aug 31, 2023

View reviewed changes

src/platform-includes/sourcemaps/upload/webpack/javascript.mdx Outdated Show resolved Hide resolved

mydea reviewed Aug 31, 2023

View reviewed changes

vercel bot deployed to Preview August 31, 2023 09:23 View deployment

Luca Forstner added 2 commits August 31, 2023 13:52

Move to bottom

9d30a3f

ugly link

ad4c052

vercel bot deployed to Preview August 31, 2023 12:01 View deployment

refactor

3afba34

vercel bot deployed to Preview August 31, 2023 14:32 View deployment

lizokm approved these changes Aug 31, 2023

View reviewed changes

mydea reviewed Sep 1, 2023

View reviewed changes

mydea approved these changes Sep 1, 2023

View reviewed changes

Apply suggestions from code review

36de537

Co-authored-by: Liza Mock <[email protected]>

lforst enabled auto-merge (squash) September 1, 2023 10:30

getsantry bot added 6 commits September 1, 2023 10:31

style(lint): Auto commit lint changes

5c6a97a

style(lint): Auto commit lint changes

0baf8d0

style(lint): Auto commit lint changes

15040aa

style(lint): Auto commit lint changes

a082c13

style(lint): Auto commit lint changes

564a869

style(lint): Auto commit lint changes

a3a7613

vercel bot deployed to Preview September 1, 2023 10:46 View deployment

lforst merged commit 4bce792 into master Sep 1, 2023

lforst deleted the lforst-org-auth-token-cli-js branch September 1, 2023 10:50

github-actions bot locked and limited conversation to collaborators Sep 17, 2023

	Visit the [Organization Auth Token Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) and create a new token or copy an existing one. Then either:
	Visit the [Organization Auth Token Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) and create a new token. Then either:

	- `SENTRY_AUTH_TOKEN` your Sentry auth token (can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/)
	- `SENTRY_AUTH_TOKEN` your Sentry auth token (can be obtained from [your Organization Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/))

Uh oh!

Use org auth token in JS and Sentry CLI docs #7714

Use org auth token in JS and Sentry CLI docs #7714

Uh oh!

Conversation

lforst commented Aug 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Aug 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lizokm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mydea left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lforst commented Aug 31, 2023 •

edited

Loading

vercel bot commented Aug 31, 2023 •

edited

Loading