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

📝 Add env variable for deploying to Vercel #10295

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changesets/10295.md
@@ -0,0 +1,19 @@
- 📝 Add env variable for deploying to Vercel (#10295) by @ahaywood

---

Updates the documentation for deploying to Vercel.

---

Fixes #10100

When you create a fresh install of Redwood and then try deploying to Vercel, it will error out unless you add the following environmental variable:

```
ENABLE_EXPERIMENTAL_COREPACK=1
```

<img width="937" alt="env-variables-within-vercel" src="https://github.com/redwoodjs/redwood/assets/212300/c57a1208-df38-4e1e-9440-0bba583194fb">

This PR adds documentation for deploying to Vercel.
11 changes: 10 additions & 1 deletion docs/docs/deploy/vercel.md
Expand Up @@ -12,7 +12,8 @@ If you simply want to experience the Vercel deployment process without a databas
1. create a new redwood project: `yarn create redwood-app ./vercel-deploy`
2. after your "vercel-deploy" project installation is complete, init git, commit, and add it as a new repo to GitHub, BitBucket, or GitLab
3. run the command `yarn rw setup deploy vercel` and commit and push changes
4. use the Vercel [Quick Start](https://vercel.com/#get-started) to deploy
4. within the environmental variables section of your project's Vercel dashboard, add `ENABLE_EXPERIMENTAL_COREPACK=1`
5. use the Vercel [Quick Start](https://vercel.com/#get-started) to deploy

_If you choose this quick deploy experience, the following steps do not apply._

Expand Down Expand Up @@ -88,3 +89,11 @@ By default, API requests in Vercel have a timeout limit of 15 seconds. To extend
}
}
```

## Environmental Variables
Within the Environmental Variables section of your project's Vercel dashboard, add:

```
ENABLE_EXPERIMENTAL_COREPACK=1
```