Unverified Commit f5bdf1ba authored by Joseph's avatar Joseph Committed by GitHub

docs: document deploymentId build ID override and Pages Router skew in 16.2 (#97645)

- Addressing: https://github.com/vercel/next.js/issues/97632
parent 508e563c
...@@ -182,6 +182,8 @@ module.exports = { ...@@ -182,6 +182,8 @@ module.exports = {
} }
``` ```
> **Good to know:** When [`deploymentId`](/docs/app/api-reference/config/next-config-js/deploymentId) is set, Next.js uses a constant build ID and `generateBuildId` has no effect. [Version skew](#version-skew) is detected from the deployment ID instead.
## Multi-Server Deployments ## Multi-Server Deployments
When running Next.js across multiple server instances (for example, containers behind a load balancer), there are additional considerations to ensure consistent behavior. When running Next.js across multiple server instances (for example, containers behind a load balancer), there are additional considerations to ensure consistent behavior.
......
...@@ -68,10 +68,13 @@ module.exports = { ...@@ -68,10 +68,13 @@ module.exports = {
} }
``` ```
A per-deployment value only avoids skew if requests are also routed by deployment. Next.js does not route on `?dpl=`, so that routing comes from your host or CDN. Without it, clients that reach an instance from another deployment during a rollout will reload rather than navigate.
## Version History ## Version History
| Version | Changes | | Version | Changes |
| ---------- | ----------------------------------------------------- | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `v16.2.0` | Pages Router detects version skew from the response header rather than the build ID, and the build ID is constant when `deploymentId` is set. |
| `v14.1.4` | `deploymentId` stabilized as top-level config option. | | `v14.1.4` | `deploymentId` stabilized as top-level config option. |
| `v13.4.10` | `experimental.deploymentId` introduced. | | `v13.4.10` | `experimental.deploymentId` introduced. |
......
...@@ -17,3 +17,5 @@ module.exports = { ...@@ -17,3 +17,5 @@ module.exports = {
}, },
} }
``` ```
> **Good to know:** When [`deploymentId`](/docs/app/api-reference/config/next-config-js/deploymentId) is set, Next.js uses a constant build ID and `generateBuildId` has no effect. [Version skew](/docs/app/guides/self-hosting#version-skew) is detected from the deployment ID instead.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment