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.

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

[wrangler] replace mentions of wrangler.json with wrangler.json(c) #19764

Merged
merged 3 commits into from
Feb 12, 2025

Conversation

emily-shen
Copy link
Contributor

Summary

C3 will be outputting wrangler.jsonc instead of plain .json, to reduce user confusion about the comments in wrangler.json.
This is being carried out in this workers-sdk PR: cloudflare/workers-sdk#8024

@github-actions github-actions bot added product:workers Related to Workers product product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ product:workflows Workflows: https://developers.cloudflare.com/workflows/ labels Feb 5, 2025
Copy link

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: dc60a3c
Status: ✅  Deploy successful!
Preview URL: https://92f5cdeb.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev

View logs

Copy link
Contributor

github-actions bot commented Feb 5, 2025

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/wrangler/commands/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/wrangler/commands/
https://developers.cloudflare.com/pages/functions/wrangler-configuration/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/pages/functions/wrangler-configuration/
https://developers.cloudflare.com/workers/wrangler/configuration/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/wrangler/configuration/
https://developers.cloudflare.com/pages/functions/bindings/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/pages/functions/bindings/
https://developers.cloudflare.com/workers/static-assets/routing/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/static-assets/routing/
https://developers.cloudflare.com/workers/tutorials/connect-to-turso-using-workers/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/tutorials/connect-to-turso-using-workers/
https://developers.cloudflare.com/d1/get-started/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/d1/get-started/
https://developers.cloudflare.com/hyperdrive/configuration/local-development/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/hyperdrive/configuration/local-development/
https://developers.cloudflare.com/queues/get-started/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/queues/get-started/
https://developers.cloudflare.com/workers-ai/tutorials/build-a-retrieval-augmented-generation-ai/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers-ai/tutorials/build-a-retrieval-augmented-generation-ai/
https://developers.cloudflare.com/workers/configuration/cron-triggers/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/configuration/cron-triggers/
https://developers.cloudflare.com/workers/local-development/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/local-development/
https://developers.cloudflare.com/workers/tutorials/deploy-a-realtime-chat-app/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/tutorials/deploy-a-realtime-chat-app/
https://developers.cloudflare.com/workers/wrangler/api/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/workers/wrangler/api/
https://developers.cloudflare.com/ai-gateway/integrations/aig-workers-ai-binding/ https://emily-wrangler-jsonc.cloudflare-docs-7ou.pages.dev/ai-gateway/integrations/aig-workers-ai-binding/

@punkeel
Copy link
Member

punkeel commented Feb 7, 2025

wrangler.json(c) seems confusing to me as it's NOT a valid file name? wrangler.json and wrangler.json are valid

Can we pick one and stick to it? (Note: I don't own a product impacted by this and don't have any decision power here :))

@emily-shen emily-shen requested review from thomasgauvin and a team as code owners February 11, 2025 14:41
Copy link
Contributor

github-actions bot commented Feb 11, 2025

Preview URL: https://8fa04c10.preview.developers.cloudflare.com
Preview Branch URL: https://emily-wrangler-jsonc.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/wrangler/commands/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/workers/wrangler/commands/
https://developers.cloudflare.com/pages/functions/wrangler-configuration/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/pages/functions/wrangler-configuration/
https://developers.cloudflare.com/workers/wrangler/configuration/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/workers/wrangler/configuration/
https://developers.cloudflare.com/pages/functions/bindings/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/pages/functions/bindings/
https://developers.cloudflare.com/workers-ai/tutorials/build-a-retrieval-augmented-generation-ai/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/workers-ai/tutorials/build-a-retrieval-augmented-generation-ai/
https://developers.cloudflare.com/workers/static-assets/routing/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/workers/static-assets/routing/
https://developers.cloudflare.com/workers/tutorials/connect-to-turso-using-workers/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/workers/tutorials/connect-to-turso-using-workers/
https://developers.cloudflare.com/workers/wrangler/api/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/workers/wrangler/api/
https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/configuration/static-assets/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/configuration/static-assets/
https://developers.cloudflare.com/d1/get-started/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/d1/get-started/
https://developers.cloudflare.com/developer-spotlight/tutorials/creating-a-recommendation-api/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/developer-spotlight/tutorials/creating-a-recommendation-api/
https://developers.cloudflare.com/developer-spotlight/tutorials/fullstack-authentication-with-next-js-and-cloudflare-d1/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/developer-spotlight/tutorials/fullstack-authentication-with-next-js-and-cloudflare-d1/
https://developers.cloudflare.com/hyperdrive/configuration/local-development/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/hyperdrive/configuration/local-development/
https://developers.cloudflare.com/queues/get-started/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/queues/get-started/
https://developers.cloudflare.com/workers/configuration/cron-triggers/ https://emily-wrangler-jsonc.preview.developers.cloudflare.com/workers/configuration/cron-triggers/

@emily-shen
Copy link
Contributor Author

wrangler.json(c) seems confusing to me as it's NOT a valid file name? wrangler.json and wrangler.json are valid

Can we pick one and stick to it? (Note: I don't own a product impacted by this and don't have any decision power here :))

Yeah I was trying (somewhat unsuccessfully it seems) to convey that both wrangler.json and wrangler.jsonc would be accepted, but i've just sidestepped the issue by referring to a "Wrangler configuration file" instead :)

@emily-shen emily-shen enabled auto-merge (squash) February 12, 2025 10:05
@kodster28 kodster28 mentioned this pull request Feb 12, 2025
@emily-shen emily-shen disabled auto-merge February 12, 2025 13:41
@emily-shen emily-shen merged commit 98fcddb into production Feb 12, 2025
11 checks passed
@emily-shen emily-shen deleted the emily/wrangler-jsonc branch February 12, 2025 13:41
jonesphillip pushed a commit that referenced this pull request Feb 12, 2025
…19764)

* update references of wrangler.json to wrangler.json(c)

* change to wrangler config file with link

* Update src/content/partials/workers/secrets-in-dev.mdx

---------

Co-authored-by: Jun Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:agents product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ product:analytics Related to Analytics product product:browser-rendering product:cloudflare-for-platforms product:cloudflare-one product:d1 D1: https://developers.cloudflare.com/d1/ product:developer-spotlight product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:email-routing product:hyperdrive Hyperdrive: https://developers.cloudflare.com/hyperdrive/ product:kv product:learning-paths product:pages product:pub-sub Pub/Sub: https://developers.cloudflare.com/pub-sub product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:r2 R2 object storage: https://developers.cloudflare.com/r2 product:radar product:style-guide product:turnstile product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ product:workers Related to Workers product product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ product:workflows Workflows: https://developers.cloudflare.com/workflows/ size/l
Projects
None yet
Development

Successfully merging this pull request may close these issues.