-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
new: Document failOnPrerenderConflict experimental flag
#12237
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2233c7c
new: Document `failOnPrerenderConflict` experimental flag
Fryuni a76f53e
Update src/content/docs/en/reference/experimental-flags/fail-on-prere…
Fryuni c8623ac
Merge branch 'main' into new/experimental-prerender-conflict
sarah11918 ae2e685
updating so we can work from this version!
sarah11918 c19fe5c
Merge branch '5.14.0' into new/experimental-prerender-conflict
sarah11918 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
src/content/docs/en/reference/experimental-flags/fail-on-prerender-conflict.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| title: Experimental prerender conflict error | ||
| sidebar: | ||
| label: Prerender conflict error | ||
| i18nReady: true | ||
| --- | ||
|
|
||
| import Since from '~/components/Since.astro' | ||
|
|
||
| <p> | ||
|
|
||
| **Type:** `boolean`<br /> | ||
| **Default:** `false`<br /> | ||
| <Since v="5.14.0" /> | ||
| </p> | ||
|
|
||
| Turns prerender conflict warnings into errors during the build process. | ||
|
|
||
| Multiple dynamic routes can result in the same output path; for example, both `/blog/[slug]` and `/blog/[...all]` could try to prerender the `/blog/post-1` path. In such cases, Astro will warn you about the conflict during build and render only the [highest priority route](/en/guides/routing/#route-priority-order) for the conflicting path. With this flag set, the build will instead fail immediately with an error. | ||
|
|
||
| This will be the default behavior in Astro 6. | ||
|
|
||
| Enable it in your `astro.config.mjs`: | ||
|
|
||
| ```js | ||
| // astro.config.mjs | ||
| defineConfig({ | ||
| experimental: { | ||
| failOnPrerenderConflict: true, | ||
| }, | ||
| }); | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.