Skip to content

feat(create-cloudflare): Add support for wrangler.json(c) in templates#7484

Merged
CarmenPopoviciu merged 1 commit intocloudflare:mainfrom
maxwellpeterson:template-wrangler-json
Dec 12, 2024
Merged

feat(create-cloudflare): Add support for wrangler.json(c) in templates#7484
CarmenPopoviciu merged 1 commit intocloudflare:mainfrom
maxwellpeterson:template-wrangler-json

Conversation

@maxwellpeterson
Copy link
Copy Markdown
Member

@maxwellpeterson maxwellpeterson commented Dec 6, 2024

Fixes WP-1369.

  • For external templates, use wrangler.json(c) if it exists instead of wrangler.toml
  • All templates in cloudflare/templates use wrangler.json
    • We need to support these templates in C3 before public launch

How to Test

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-create-cloudflare-7484 --no-auto-update --template=cloudflare/templates/multiplayer-globe-template

cloudflare/templates/multiplayer-globe-template uses wrangler.json instead of wrangler.toml. If you try to use this template with the latest version of C3 it fails because the template doesn't contain a wrangler.toml file:

$ npm create cloudflare@latest -- --template=cloudflare/templates/multiplayer-globe-template

Error: create-cloudflare templates must contain a "wrangler.toml" file

  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: I'm adding support for something that already exists

- If wrangler.toml is missing, check for wrangler.json(c) before failing
- All templates in the cloudflare/templates repository use wrangler.json
  - We need to support these templates in C3 before public launch
@maxwellpeterson maxwellpeterson requested a review from a team December 6, 2024 18:50
@maxwellpeterson maxwellpeterson requested a review from a team as a code owner December 6, 2024 18:50
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Dec 6, 2024

🦋 Changeset detected

Latest commit: 35e1510

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
create-cloudflare Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 6, 2024

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-wrangler-7484

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/7484/npm-package-wrangler-7484

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-wrangler-7484 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-create-cloudflare-7484 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-cloudflare-kv-asset-handler-7484
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-miniflare-7484
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-cloudflare-pages-shared-7484
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-cloudflare-vitest-pool-workers-7484
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-cloudflare-workers-editor-shared-7484
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-cloudflare-workers-shared-7484
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12204431707/npm-package-cloudflare-workflows-shared-7484

Note that these links will no longer work once the GitHub Actions artifact expires.


wrangler@3.93.0 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20241205.0
workerd 1.20241205.0 1.20241205.0
workerd --version 1.20241205.0 2024-12-05

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

@CarmenPopoviciu CarmenPopoviciu added the e2e Run wrangler + vite-plugin e2e tests on a PR label Dec 12, 2024
@CarmenPopoviciu CarmenPopoviciu merged commit 4fe93de into cloudflare:main Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

e2e Run wrangler + vite-plugin e2e tests on a PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants