Skip to content

wrangler config - add extended configuration docs #18146

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

Closed
wants to merge 2 commits into from
Closed

wrangler config - add extended configuration docs #18146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1650a43
wrangler config - add extended configuration docs
petebacondarwin Nov 13, 2024
246d57b
Merge branch 'production' into pbd/docs-for-wrangler-config-extension
ToriLindsay Dec 2, 2024
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
12 changes: 12 additions & 0 deletions src/content/docs/workers/wrangler/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1252,3 +1252,15 @@ If you change your environment variables in the Cloudflare dashboard, Wrangler w
If you change your routes in the dashboard, Wrangler will override them in the next deploy with the routes you have set in your Wrangler configuration file. To manage routes via the Cloudflare dashboard only, remove any route and routes keys from your Wrangler configuration file. Then add `workers_dev = false` to your Wrangler configuration file. For more information, refer to [Deprecations](/workers/wrangler/deprecations/#other-deprecated-behavior).

Wrangler will not delete your secrets (encrypted environment variables) unless you run `wrangler secret delete <key>`.

## 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.
Copy link
Contributor

@ToriLindsay ToriLindsay Dec 2, 2024

Choose a reason for hiding this comment

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

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 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.
Copy link
Contributor

@ToriLindsay ToriLindsay Dec 2, 2024

Choose a reason for hiding this comment

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

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 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.
Copy link
Contributor

@ToriLindsay ToriLindsay Dec 2, 2024

Choose a reason for hiding this comment

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

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 configuration in this file will be merged into the configuration of the currently selected environment before being used in all Wrangler commands.
Copy link
Contributor

@ToriLindsay ToriLindsay Dec 2, 2024

Choose a reason for hiding this comment

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

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.


Copy link
Contributor

@ToriLindsay ToriLindsay Dec 2, 2024

Choose a reason for hiding this comment

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

Suggested change

The user does not need to manually specify that this merging should happen. It is done automatically when the file is found.
Copy link
Contributor

@ToriLindsay ToriLindsay Dec 2, 2024

Choose a reason for hiding this comment

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

Suggested change
The user does not need to manually specify that this merging should happen. It is done automatically when the file is found.

Copy link
Contributor

@ToriLindsay ToriLindsay Dec 2, 2024

Choose a reason for hiding this comment

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

Added this into the sentence above