Skip to content

Commit b25e50b

Browse files
committed
Add clarification about GitHub orgs to Sentry orgs
1 parent 77d8187 commit b25e50b

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

gatsby/src/docs/workflow/integrations/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ These integrations are set up once per organization, and are then usable in all
1616
- [_JIRA_](/workflow/integrations/jira/) (and Jira Server)
1717
- [_PagerDuty_](/workflow/integrations/pagerduty/)
1818
- [_Slack_](/workflow/integrations/slack/)
19+
- [_Vercel_](/workflow/integrations/vercel/)
20+
1921

2022
These integrations are maintained and supported by the companies that created them. See [integration platform](/workflow/integrations/integration-platform/).
2123

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Vercel
3+
sidebar_order: 1
4+
---
5+
6+
### Vercel
7+
8+
Vercel is an all-in-one platform with Global CDN supporting static and JAMstack deployment and Serverless Functions. Connect your Sentry and Vercel projects to automatically upload source maps and notify Sentry of release deployment.
9+
10+
**Installation**
11+
12+
1. Visit <https://vercel.com/integrations/sentry/add>
13+
14+
2. Select your account and click "Add".
15+
16+
[{% asset vercel/vercel_install.png alt="Sentry modal showing Vercel installation." %}]({% asset vercel/vercel_install.png @path %})
17+
18+
**Note that the installation created an internal integration to generate an auth token used in building releases. If the Vercel internal integration is deleted, your Vercel integration will stop working!**
19+
20+
[{% asset vercel/vercel_internal_integration.png alt="Sentry modal showing Vercel internal integration." %}]({% asset vercel/vercel_internal_integration.png @path %})
21+
22+
**Project Linking**
23+
24+
1. Select a Sentry project and a Vercel project to link together.
25+
26+
[{% asset vercel/vercel_link_project.png alt="Sentry modal showing linking Sentry project to Vercel project." %}]({% asset vercel/vercel_link_project.png @path %})
27+
28+
* This step will generate environment variables in the selected Vercel project. Having these set means you can skip the [CLI Configuration step](https://github.com/getsentry/sentry-webpack-plugin#cli-configuration) in the Sentry Webpack Plugin setup. You can see these in Vercel in **Project Settings** > **General** > **Environment Variables**.
29+
30+
31+
[{% asset vercel/vercel_env_vars.png alt="Sentry modal showing linking Sentry project to Vercel project." %}]({% asset vercel/vercel_env_vars.png @path %})
32+
33+
* `SENTRY_ORG` - the name of your Sentry organization
34+
* `SENTRY_PROJECT` - the name of your linked Sentry project
35+
* `SENTRY_AUTH_TOKEN` - the auth token from the Vercel Internal Integration that was created upon installation
36+
* `NEXT_PUBLIC_SENTRY_DSN` - the linked Sentry project's DSN
37+
* `VERCEL_GITHUB_COMMIT_SHA`, `VERCEL_GITLAB_COMMIT_SHA`, or `VERCEL_BITBUCKET_COMMIT_SHA` - your source code provider's commit SHA, used for creating releases and associating commits
38+
39+
2. Redeploy your Vercel project in order to trigger a release.
40+
41+
**Usage**
42+
43+
* If you have not already done so, [instrument your code with Sentry]({%- link _documentation/error-reporting/quickstart.md -%}).
44+
* Ensure you have [installed a repository integration]({%- link _documentation/workflow/releases/index.md -%}#install-repo-integration) and added the relevant repository.
45+
* Add the [Sentry Webpack Plugin](https://github.com/getsentry/sentry-webpack-plugin) to your configuration. For NextJS, use `next.config.js`.
46+
47+
* If you already have a Vercel project integrated with Sentry, ensure the Sentry project you link is the one you're already using to report errors.
48+
49+
**Uninstallation**
50+
51+
1. The integration must be uninstalled from Vercel. Visit the Vercel integration configuration page (**Organization Settings** > **Integrations** > **Vercel** > **Configurations**) and click "Uninstall" then "Visit Vercel" in the modal that pops up.
52+
53+
[{% asset vercel/vercel_uninstall.png alt="Sentry modal showing uninstalling Vercel integration." %}]({% asset vercel/vercel_uninstall.png @path %})
54+
55+
2. Click "Remove Configuration"
56+
57+
3. Delete the internal integration that was created by navigating to **Organization Settings** > **Developer Settings** and clicking the trash can icon next to **Vercel Internal Integration**. You will be prompted to confirm the deletion by entering a string provided in the modal. Enter the string and click "Confirm" to finalize the deletion.
58+
59+
[{% asset vercel/vercel_delete_internal_integration.png alt="Sentry modal showing uninstalling Vercel integration." %}]({% asset vercel/vercel_delete_internal_integration.png @path %})

0 commit comments

Comments
 (0)