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

[docs] update wrangler.toml example to wrangler@2 #5187

Merged
merged 3 commits into from
Jun 21, 2022

Conversation

EstebanBorai
Copy link
Contributor

Updates the example provided for wrangler.toml file for
the adapter-cloudflare-workers documentation, to follow
the specs on wrangler@2.

Changes from Cloudflare include:

  • The type key is no longer needed.
  • The zone_id is unnecessary since they can deduce this from routes directly.
  • The compatibility_date is required when publishing.
  • The main key belongs to the global scope, instead of the build.upload section
  • The format key is inferred automatically from the code.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

Updates the example provided for `wrangler.toml` file for
the `adapter-cloudflare-workers` documentation, to follow
the specs on wrangler@2.
@changeset-bot
Copy link

changeset-bot bot commented Jun 9, 2022

🦋 Changeset detected

Latest commit: 3d8ef40

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

This PR includes changesets to release 1 package
Name Type
@sveltejs/adapter-cloudflare-workers Patch

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

@benmccann benmccann changed the title fix: update wrangler.toml example to wrangler@2 [docs] update wrangler.toml example to wrangler@2 Jun 13, 2022
@benmccann benmccann added documentation Improvements or additions to documentation pkg:adapter-cloudflare-workers labels Jun 15, 2022
@benmccann
Copy link
Member

@EstebanBorai are there also changes needed to the adapter-cloudflare readme in addition to adapter-cloudflare-workers?

@benmccann benmccann requested review from lukeed and pngwn June 15, 2022 11:50
@EstebanBorai
Copy link
Contributor Author

Hi @benmccann! As far as I have been able to test no.

Given that the adapter-cloudflare is intended for Cloudflare Pages, theres no need to provide a wrangler.toml yourself.

@Rich-Harris
Copy link
Member

Thanks! I made some further changes — the README was quite out of date, and it turns out we can simplify it quite a bit

@Rich-Harris Rich-Harris merged commit f5b409f into sveltejs:master Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pkg:adapter-cloudflare-workers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants