Skip to content

Commit 0a152d4

Browse files
committed
Add Vercel Integration Docs
1 parent 4b3f674 commit 0a152d4

File tree

8 files changed

+55
-1
lines changed

8 files changed

+55
-1
lines changed
13.7 KB
Loading
Loading
24.8 KB
Loading
3.89 KB
Loading
Loading
14.5 KB
Loading
8.79 KB
Loading

src/collections/_documentation/workflow/integrations/global-integrations.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1022,7 +1022,7 @@ Follow the instructions in the link below:
10221022
10231023
## Code Linking
10241024
1025-
These integrations will allow seamlessly connect a Sentry error to the underlying code behind the error in a separate platform.
1025+
These integrations will allow you to seamlessly connect a Sentry error to the underlying code behind the error in a separate platform.
10261026
10271027
### Rookout
10281028
@@ -1082,6 +1082,60 @@ The Split integration is only available for organizations on the Business and En
10821082
Follow the instructions in the link below:
10831083
<https://help.split.io/hc/en-us/articles/360029879431>
10841084
1085+
## Deployment
1086+
1087+
These integrations will assist in automating your release and deployment process, making understanding your errors simpler.
1088+
1089+
### Vercel
1090+
1091+
Vercel is an all-in-one platform with Global CDN supporting static & JAMstack deployment and Serverless Functions. Connect your Sentry and Vercel projects to automatically upload source maps and notify Sentry of new releases being deployed.
1092+
1093+
**Installation**
1094+
1095+
1. In Sentry, navigate to **Organization Settings** > **Integrations**.
1096+
1097+
2. Find Vercel in the list of the available Global Integrations list and click **Vercel**.
1098+
1099+
[{% asset vercel/vercel_install_sentry.png alt="Sentry modal showing Vercel installation." %}]({% asset vercel/vercel_install_sentry.png @path %})
1100+
1101+
3. Click the "Vercel Marketplace" button at the top right to install the integration.
1102+
1103+
[{% asset vercel/vercel_marketplace.png alt="Sentry modal showing Vercel marketplace button." %}]({% asset vercel/vercel_marketplace.png @path %})
1104+
1105+
4. Select your account and click "Add".
1106+
1107+
[{% asset vercel/vercel_install.png alt="Sentry modal showing Vercel installation." %}]({% asset vercel/vercel_install.png @path %})
1108+
1109+
**Note that the installation created an internal integration for the purpose of creating an auth token used in creating releases. If the Vercel internal integration is deleted, your Vercel integration will stop working!**
1110+
1111+
[{% asset vercel/vercel_internal_integration.png alt="Sentry modal showing Vercel internal integration." %}]({% asset vercel/vercel_internal_integration.png @path %})
1112+
1113+
**Project Linking**
1114+
1115+
1. Select a Sentry project and a Vercel project to link together.
1116+
1117+
[{% asset vercel/vercel_link_project.png alt="Sentry modal showing linking Sentry project to Vercel project." %}]({% asset vercel/vercel_link_project.png @path %})
1118+
1119+
This step will generate environment variables in the selected Vercel project. You can see these in Vercel in **Project Settings** > **General** > **Environment Variables**.
1120+
1121+
**Usage**
1122+
1123+
* If you have not already done so, [instrument your code with Sentry]({%- link _documentation/error-reporting/quickstart.md -%}).
1124+
* Ensure you have [installed a repository integration]({%- link _documentation/workflow/releases/index.md -%}#install-repo-integration).
1125+
* Add the [Sentry Webpack Plugin](https://github.com/getsentry/sentry-webpack-plugin) to your configuration. For NextJS, use `next.config.js`.
1126+
1127+
**Uninstallation**
1128+
1129+
1. From the Vercel integration configuration page (**Organization Settings** > **Integrations** > **Vercel**) you can uninstall the integration.
1130+
1131+
[{% asset vercel/vercel_delete.png alt="Sentry modal showing uninstalling Vercel integration." %}]({% asset vercel/vercel_delete.png @path %})
1132+
1133+
1134+
2. 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 this and click "Confirm" to finalize the deletion.
1135+
1136+
[{% asset vercel/vercel_delete_internal_integration.png alt="Sentry modal showing uninstalling Vercel integration." %}]({% asset vercel/vercel_delete_internal_integration.png @path %})
1137+
1138+
10851139
## Troubleshooting
10861140
If you're having trouble setting up Sentry with your on-premise integration like JIRA Server, Bitbucket Server, GitHub Enterprise, or Gitlab:
10871141
- Ensure that the installation URL you provided is a fully qualified domain name (FQDN), which is resolvable on the internet.

0 commit comments

Comments
 (0)