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

Jump to bottom

adding note that edge api routes are not supported with ISR #43572

Merged
merged 4 commits into from Dec 1, 2022
Merged

adding note that edge api routes are not supported with ISR #43572

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
77fe369
adding note that edge api routes are not supported with ISR
timeyoutakeit Nov 30, 2022
a5f4f0e
Update docs/basic-features/data-fetching/incremental-static-regenerat…
timeyoutakeit Dec 1, 2022
710288b
lint fix
ijjk Dec 1, 2022
b89eef0
Merge branch 'canary' into timeyoutakeit/edge-note
ijjk Dec 1, 2022
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
2 changes: 2 additions & 0 deletions docs/basic-features/data-fetching/incremental-static-regeneration.md
View file
Open in desktop
Expand Up @@ -27,6 +27,8 @@ description: 'Learn how to create or update static pages at runtime with Increme

Next.js allows you to create or update static pages _after_ you’ve built your site. Incremental Static Regeneration (ISR) enables you to use static-generation on a per-page basis, **without needing to rebuild the entire site**. With ISR, you can retain the benefits of static while scaling to millions of pages.

> Note: the `experimental-edge` runtime (https://nextjs.org/docs/api-reference/edge-runtime) is currently not compatible with ISR although can leverage `stale-while-revalidate` by setting the `cache-control` header manually.
Copy link
Member

@leerob leerob Dec 1, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this could be a bit confusing: ISR isn't just caching!

Note: The Edge Runtime is not currently compatible with ISR. Ensure you are using the default Node.js runtime with ISR.

This note is also pretty high up on the page for something I don't think most people need to know.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm yeah it's not just caching although the cache-control header provides an alternative in the mean-time while it's implemented and I don't think we want to burry this note for users who are confused by this.

We potentially could make this a build time warning instead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Build time warning makes sense to me 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "not currently compatible" look like? Will it just never update? Will it error? Will it do nothing?


To use ISR, add the `revalidate` prop to `getStaticProps`:

```jsx
Expand Down