wrangler config - add extended configuration docs #18146
Closed
Conversation
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
petebacondarwin
requested review from
a team,
GregBrimble,
dario-piotrowicz,
irvinebroque and
penalosa
as code owners
9 tasks
petebacondarwin
force-pushed
the
pbd/docs-for-wrangler-config-extension
branch
from
228ad4e to
1650a43
Compare
ToriLindsay
approved these changes
Dec 2, 2024
|
|
||
| ## Extending user configuration | ||
|
|
||
| The main goal here is to allow tools to generate a partial configuration file that is merged into the user configuration when Wrangler commands are run. |
Contributor
There was a problem hiding this comment.
Suggested change
| The main goal here is to allow tools to generate a partial configuration file that is merged into the user configuration when Wrangler commands are run. | |
| You can allow tools to generate a partial configuration file that is merged into the user configuration when Wrangler commands are run. |
|
|
||
| The main goal here is to allow tools to generate a partial configuration file that is merged into the user configuration when Wrangler commands are run. | ||
|
|
||
| The file must be written to `./.wrangler/config/extra.json`. This path is relative to the project path, which is the directory containing the wrangler.toml or the current working directory if there is no wrangler.toml. |
Contributor
There was a problem hiding this comment.
Suggested change
| The file must be written to `./.wrangler/config/extra.json`. This path is relative to the project path, which is the directory containing the wrangler.toml or the current working directory if there is no wrangler.toml. | |
| Write the partial configuration file to `./.wrangler/config/extra.json` in the current project directory, which is typically the directory containing the wrangler.toml. |
|
|
||
| The file must be written to `./.wrangler/config/extra.json`. This path is relative to the project path, which is the directory containing the wrangler.toml or the current working directory if there is no wrangler.toml. | ||
|
|
||
| The format of the file is a JSON object whose properties are the [inheritable](#inheritable-keys) and [non-inheritable](#non-inheritable-keys) keys described above. Notably it cannot contain the [top level only](#top-level-only-keys) configuration keys. |
Contributor
There was a problem hiding this comment.
Suggested change
| The format of the file is a JSON object whose properties are the [inheritable](#inheritable-keys) and [non-inheritable](#non-inheritable-keys) keys described above. Notably it cannot contain the [top level only](#top-level-only-keys) configuration keys. | |
| The file must be a JSON object, containing the [inheritable](#inheritable-keys) and [non-inheritable](#non-inheritable-keys) keys described above. It cannot contain [top level only](#top-level-only-keys) keys. |
|
|
||
| The format of the file is a JSON object whose properties are the [inheritable](#inheritable-keys) and [non-inheritable](#non-inheritable-keys) keys described above. Notably it cannot contain the [top level only](#top-level-only-keys) configuration keys. | ||
|
|
||
| The configuration in this file will be merged into the configuration of the currently selected environment before being used in all Wrangler commands. |
Contributor
There was a problem hiding this comment.
Suggested change
| The configuration in this file will be merged into the configuration of the currently selected environment before being used in all Wrangler commands. | |
| The configuration in this file is merged with the the currently selected environment and applied to all Wrangler commands. No manual action is required because Wrangler automatically detects and applies the file when it is present. |
| The format of the file is a JSON object whose properties are the [inheritable](#inheritable-keys) and [non-inheritable](#non-inheritable-keys) keys described above. Notably it cannot contain the [top level only](#top-level-only-keys) configuration keys. | ||
|
|
||
| The configuration in this file will be merged into the configuration of the currently selected environment before being used in all Wrangler commands. | ||
|
|
|
|
||
| The configuration in this file will be merged into the configuration of the currently selected environment before being used in all Wrangler commands. | ||
|
|
||
| The user does not need to manually specify that this merging should happen. It is done automatically when the file is found. |
Contributor
There was a problem hiding this comment.
Suggested change
| The user does not need to manually specify that this merging should happen. It is done automatically when the file is found. |
Contributor
There was a problem hiding this comment.
Added this into the sentence above
Contributor
|
Hi @petebacondarwin - I left some suggestions for making the content more direct and verb-driven. |
Contributor
Author
|
Oh I'm sorry @ToriLindsay - I meant to set this to draft. We are reconsidering the approach described here, so the docs will change considerably. But I appreciate the input and will try to follow it in the reworked PR later this week. |
9 tasks
Contributor
Author
|
Closing as we are implementing this in a different way. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Summary
Add Wrangler extended configuration docs.
Documentation checklist