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.

Sign up for GitHub

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

chore(vercel): Add beta option for status #9413

Merged
merged 12 commits into from
Dec 13, 2023
Merged

chore(vercel): Add beta option for status #9413

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a462366
Add beta option for status
Dec 12, 2023
2be4655
Create stupid-cheetahs-sell.md
Dec 12, 2023
cce926a
Merge branch 'main' into chore/update-supported-node-versions
Dec 12, 2023
bfd0770
Add warning for beta
Dec 12, 2023
3e5dd9f
Merge branch 'chore/update-supported-node-versions' of https://github…
Dec 12, 2023
943b5cf
Update packages/integrations/vercel/src/serverless/adapter.ts
Dec 12, 2023
fd96f1f
Switch to `minor` and document new API/option
Dec 12, 2023
d659d7d
Update README.md
Dec 12, 2023
f1649b2
Merge branch 'main' into chore/update-supported-node-versions
Dec 12, 2023
f948305
Update README.md
Dec 12, 2023
8da6099
Update packages/integrations/vercel/README.md
Dec 13, 2023
b2f12b6
Update .changeset/stupid-cheetahs-sell.md
Dec 13, 2023
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
2 changes: 1 addition & 1 deletion .changeset/stupid-cheetahs-sell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
'@astrojs/vercel': patch
'@astrojs/vercel': minor
---

Update supported Node versions and add `beta` option.
16 changes: 16 additions & 0 deletions packages/integrations/vercel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,22 @@ When you opt in to this feature, there are few constraints to note:
- Only `request` and `context` may be used to produce an `Astro.locals` object. Operations like redirects, etc. should be delegated to Astro middleware.
- `Astro.locals` **must be serializable**. Failing to do so will result in a **runtime error**. This means that you **cannot** store complex types like `Map`, `function`, `Set`, etc.

To update the `README.md` file for the `@astrojs/vercel` package to reflect your recent changes, you should include a new section that documents the changes made to the `SUPPORTED_NODE_VERSIONS` and the behavior of the `validateRuntime` function. This will ensure that users are aware of the new Node.js versions supported and the addition of the 'beta' status for certain versions.

Here's a suggested addition to the `README.md` file:

### Node.js Version Support and Runtime Validation

The `@astrojs/vercel` adapter supports specific Node.js versions for deploying your Astro project on Vercel. The supported versions are categorized as 'current', 'beta', and 'deprecated'. Each category represents the support status of that Node.js version:

- **Current**: Fully supported and recommended for use.
- **Beta**: Newer versions that are in beta. These are available for testing and early adoption.
- **Deprecated**: Versions that are no longer recommended and scheduled for removal on a specific date.

#### Supported Node.js Versions

To view the supported Node.js versions, click on the settings tab for a project and scroll down to "Node.js Version" section.

## Troubleshooting

**A few known complex packages (example: [puppeteer](https://github.com/puppeteer/puppeteer)) do not support bundling and therefore will not work properly with this adapter.** By default, Vercel doesn't include npm installed files & packages from your project's `./node_modules` folder. To address this, the `@astrojs/vercel` adapter automatically bundles your final build output using `esbuild`.
Expand Down