-
Notifications
You must be signed in to change notification settings - Fork 71
vercel integration docs #545
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| title: Vercel | ||
| headline: Vercel |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| id: vercel-integration | ||
| title: Integration | ||
| description: Connect Directus with Vercel to trigger deployments, monitor build status, and manage your frontend projects directly from your Directus instance. | ||
| technologies: | ||
| - vercel | ||
| --- | ||
|
|
||
| Connect your Directus instance with Vercel to centrally manage deployments, monitor build status, and control multiple frontend projects — all without leaving Directus. | ||
|
|
||
|
|
||
| ::callout{icon="heroicons-outline:rocket-launch"} | ||
| **Quick Start** | ||
| 1. **Enable Deployment module**: Enable the Deployment module from your Directus project settings | ||
| 2. **Connect your Vercel account**: Navigate to the Deployment module and add your Vercel API token | ||
| 3. **Add projects**: Connect one or more Vercel projects to your Directus instance | ||
JamesW1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 4. **Start deploying**: Trigger builds and monitor deployment status from Directus | ||
| :: | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Connect Your Vercel Account | ||
|
|
||
| 1. In Directus, navigate to **Settings** | ||
| 2. From the **Modules** section, enable the **Deployment** module | ||
| 3. Navigate to the Deployment module now shown in the **primary navigation** | ||
| 4. Select **Configure Vercel** to begin the integration | ||
| - **Personal Access Token**: Your Vercel API [access token](https://vercel.com/kb/guide/how-do-i-use-a-vercel-api-access-token) | ||
JamesW1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - **Team ID (optional)**: Add your [Team ID](https://vercel.com/docs/accounts#find-your-team-id) if you want to deploy team projects rather than personal projects | ||
| 5. Click **Save** to establish the connection and begin adding projects | ||
|
|
||
|  | ||
|
|
||
| ### Configure Projects | ||
|
|
||
| 1. From the **Vercel Configuration** screen, select **which Vercel projects** you want to manage from Directus | ||
| 2. Click **Save** to add the projects to the integration | ||
JamesW1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 3. You can return to the Vercel integration settings at any time to add or remove projects | ||
|
|
||
| ::callout{icon="material-symbols:warning" color="warning"} | ||
| **Removing Projects** | ||
| <br> | ||
| Removing a project from the Vercel integration will also permanently delete all deployment history for that project from Directus. This action cannot be undone. | ||
| :: | ||
|
|
||
|  | ||
|
|
||
| ### View Your Projects | ||
|
|
||
| Once configured, your connected Vercel projects will be listed in the Deployment module. From here you can: | ||
| - View all connected projects at a glance | ||
| - Access deployment controls for each project | ||
| - Monitor deployment status and history | ||
|
|
||
| ::callout{icon="material-symbols:info-outline"} | ||
| **Permissions** | ||
| <br> | ||
| **Admin Access Required (For Now)** | ||
| <br> | ||
| Currently, only admin users can trigger deployments and manage Vercel projects. Role-based permissions will be available in an upcoming release, allowing you to grant deployment access to specific users and roles. | ||
| :: | ||
|
|
||
|  | ||
|
|
||
| ## Documentation | ||
|
|
||
| **[Working with Deployments →](/guides/integrations/vercel/deployments)** | ||
|
|
||
| Trigger deployments, monitor build status, and manage your frontend projects directly from your Directus instance. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| --- | ||
| id: vercel-deployments | ||
| title: Deployments | ||
| description: Complete guide for triggering deployments, monitoring build status, and viewing logs for your Vercel projects from Directus. | ||
| technologies: | ||
| - vercel | ||
| --- | ||
|
|
||
| Once you've connected your Vercel account and configured your projects, you can manage all deployment activities directly from Directus. | ||
|
|
||
| You should trigger deployments after publishing content changes that affect your frontend. | ||
|
|
||
| **[← Back to Vercel Integration](/guides/integrations/vercel)** | ||
|
|
||
| ## Triggering Deployments | ||
|
|
||
| Trigger new deployments for any connected Vercel project: | ||
|
|
||
| 1. Navigate to the **Deployment** module | ||
| 2. Click on the **Vercel** provider | ||
| 3. Select the project you want to deploy | ||
| 4. Click the **Deploy** button in the top right | ||
| 5. Vercel will begin building and deploying your project | ||
|
|
||
| Each deployment is tracked in Directus with the associated deployment metadata. | ||
|
|
||
|  | ||
|
|
||
| ## Monitoring Deployment Status | ||
|
|
||
| ::callout{icon="material-symbols:info-outline"} | ||
| **Only deployments triggered from Directus appear in this interface**. Deployments made directly in Vercel will not be shown. | ||
| :: | ||
|
|
||
| Track the status of your deployments in the deployment list screen. The list shows: | ||
|
|
||
| - **Deployment ID**: Vercel identifier for each build | ||
| - **Status**: Current deployment state | ||
| - `BUILDING`: The deployment is currently being built | ||
| - `READY`: The project is successfully built, deployed, and live | ||
| - `CANCELED`: The deployment was canceled before completion | ||
| - `ERROR`: The deployment failed during the build or runtime phase | ||
| - **Target**: Environment (production, preview, etc.) | ||
| - **Started**: When the deployment began | ||
| - **Duration**: How long the build took | ||
| - **Author**: Who triggered the deployment | ||
|
|
||
| ## Viewing Build Logs | ||
|
|
||
| Access detailed build logs for any deployment: | ||
|
|
||
| 1. Click on any deployment from the project list | ||
| 2. View the complete build output, including: | ||
| - Build steps and timing | ||
| - Static/SSG/dynamic rendering information | ||
| - Build cache creation and upload | ||
| - Error messages (if applicable) | ||
| 3. Use the **search** function to find specific log entries | ||
| 4. Filter by **log level** (All, Stdout, Stderr) to narrow results | ||
|
|
||
| Build logs help you troubleshoot deployment issues and understand your build process. | ||
|
|
||
|  | ||
|
|
||
| ## Exporting Logs | ||
|
|
||
| Download deployment logs for documentation or troubleshooting: | ||
|
|
||
| 1. Open the deployment details view | ||
| 2. Click the **Download** icon in the top right | ||
| 3. Logs are exported as a text file with associated timestamps | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Visiting Deployed Sites | ||
|
|
||
| Quickly access your live deployments: | ||
|
|
||
| 1. From the deployment details view, click the **Visit** button | ||
| 2. Your deployed site opens in a new tab | ||
|
|
||
|  | ||
|
|
||
| ## Best Practices | ||
|
|
||
| **Deployment Workflow** | ||
| - Trigger deployments after publishing content changes that affect your frontend | ||
| - Monitor the first few deployments after setup to ensure builds complete successfully | ||
| - Keep build logs for failed deployments to troubleshoot issues | ||
|
|
||
| **Performance Tips** | ||
| - Build times shown in the deployment list help you track build performance over time | ||
| - Vercel's build cache can help improve subsequent deployment speeds | ||
|
|
||
| **Troubleshooting** | ||
| - If a deployment fails, check the build logs for specific error messages | ||
| - Verify your Vercel project configuration and build settings | ||
| - Ensure your Personal Access Token has the necessary permissions | ||
|
|
||
| ## Next Steps | ||
|
|
||
| - **[← Back to Integration](/guides/integrations/vercel)** Return to the integration overview |
JamesW1 marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
JamesW1 marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
JamesW1 marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.