Skip to content
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

Workflow Troubleshooting Page #322

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -1406,7 +1406,6 @@
"workflow/quickstarts/hono",
"workflow/quickstarts/express",
"workflow/quickstarts/astro"

]
},
{
Expand Down Expand Up @@ -1451,6 +1450,12 @@
},
"workflow/how",
"workflow/pricing",
{
"group": "Troubleshooting",
"pages": [
"workflow/troubleshooting/vercel"
]
},
"workflow/roadmap"
]
}
Expand Down
38 changes: 38 additions & 0 deletions workflow/troubleshooting/vercel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Vercel"
sidebarTitle: "Vercel"
---

# Common Issues and Solutions

### Preview Deployment Protection

**Problem:**
When Deployment Protection setting is enabled on Vercel, it's not possible to trigger and complete a workflow run on a preview deployment.

**Solution:**
Vercel provides a way to bypass this protection by using a bypass secret. To create one, follow these steps:

<Steps>
<Step title="Settings">Go to **Deployment Protection** section under your Vercel project settings.</Step>

<Step title="Find related section">
Click on **Add Secret** under **Protection Bypass for Automation** section.
<Frame>
<img src="/img/workflow/troubleshooting/vercel-deployment-protection.png" />
</Frame>
</Step>

<Step title="Generate a bypass token">Don't forget to save it.</Step>
</Steps>

Now that you have a bypass token, you can add it to your workflow URL as a query parameter.

Imagine that you have a Vercel Preview and there is a workflow endpoint at `https://vercel-preview.com/workflow`.
You can call the workflow like this in preview:

```bash
curl -X POST \
'https://vercel-preview.com/workflow?x-vercel-protection-bypass=<PROTECTION_BYPASS_SECRET>' \
-d 'Hello world!'
```