Skip to content

Commit 5a12151

Browse files
authored
Add Vercel Integration Docs (#1854)
* Add Vercel Integration Docs
1 parent 527e3c1 commit 5a12151

File tree

10 files changed

+65
-0
lines changed

10 files changed

+65
-0
lines changed

__tests__/__snapshots__/documentation.js.snap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,7 @@ Array [
446446
"workflow/integrations/slack/index.html",
447447
"workflow/integrations/split/index.html",
448448
"workflow/integrations/splunk/index.html",
449+
"workflow/integrations/vercel/index.html",
449450
"workflow/issue-owners/index.html",
450451
"workflow/releases/health/index.html",
451452
"workflow/releases/index.html",

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: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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+
![Sentry modal showing Vercel installation](vercel_install.png)
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+
![Sentry modal showing Vercel internal integration](vercel_internal_integration.png)
21+
22+
**Project Linking**
23+
24+
1. Select a Sentry project and a Vercel project to link together.
25+
26+
![Sentry modal showing linking Sentry project to Vercel project](vercel_link_project.png)
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+
![Sentry modal showing linking Sentry project to Vercel project](vercel_env_vars.png)
31+
32+
* `SENTRY_ORG` - the name of your Sentry organization
33+
* `SENTRY_PROJECT` - the name of your linked Sentry project
34+
* `SENTRY_AUTH_TOKEN` - the auth token from the Vercel Internal Integration that was created upon installation
35+
* `NEXT_PUBLIC_SENTRY_DSN` - the linked Sentry project's DSN
36+
* `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
37+
38+
2. Redeploy your Vercel project in order to trigger a release.
39+
40+
**Usage**
41+
42+
* If you have not already done so, [instrument your code with Sentry](/error-reporting/quickstart/).
43+
* Ensure you have [installed a repository integration](/workflow/releases/#install-repo-integration) and added the relevant repository.
44+
* Add the [Sentry Webpack Plugin](https://github.com/getsentry/sentry-webpack-plugin) to your configuration. For NextJS, use `next.config.js`.
45+
* 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.
46+
47+
**Uninstallation**
48+
49+
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.
50+
51+
![Sentry modal showing uninstalling Vercel integration](vercel_uninstall.png)
52+
53+
2. Click "Remove Configuration"
54+
55+
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.
56+
57+
![Sentry modal showing uninstalling Vercel integration](vercel_delete_internal_integration.png)
Loading
Loading
Loading
Loading
Loading
Loading
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Vercel
3+
sidebar_order: 1
4+
gatsby: true
5+
---

0 commit comments

Comments
 (0)