Skip to content
This repository was archived by the owner on Aug 3, 2023. It is now read-only.

v1.5.0-rc.0

Pre-release
Pre-release
Compare
Choose a tag to compare
@ashleygwilliams ashleygwilliams released this 09 Oct 15:04
v1.5.0-rc.0
099cb53

Testing Guide

Thank you so much for offering to test our upcoming release of Wrangler 1.5.0!

This release includes some fun new features, like

  • include/exclude semantics in wrangler.toml for only uploading a subset of files to a Workers Site (Workers KV)
  • deprecation of the --release flag in wrangler publish

Setup

Prerequisites:

To install Wrangler, you will need to have Node.js installed. To install Node.js, we recommend a Node.js version manager:

OSX/Linux: https://github.com/nvm-sh/nvm#install--update-script
Windows: https://github.com/nullivex/nodist#installation

Install the Wrangler release candidate:

Run this command in your terminal:

npm i @cloudflare/[email protected] -g

If you already have Wrangler installed, run:

cargo uninstall wrangler
npm i @cloudflare/[email protected] -g

To test that you have installed the right version run:

wrangler --version

You should see this output:

👷 ✨  wrangler 1.5.0-rc.0

Configure Wrangler

If you previously had Wrangler installed, you should be able to skip this step.

Run this in your terminal:

wrangler config

Wrangler will prompt you to enter your Global API Key and the associated email address of the Cloudflare account you'd like to use. You can find your Global API Key in the Cloudflare Dashboard. For more details, click here.

Note: Wrangler does not currently work with API Tokens. Coming soon in Q4!

Test that your configuration worked by running:

wrangler whoami

You should see output similar to this:

💁 👋 You are logged with the email '[email protected]'.

Tasks

We'd like you to test scenarios containing a few tasks each. Please try to use the documentation we've provided. If you find the documentation is incomplete or that you need to ask a question, please note that for us! We'd like the documentation to be as self-serve as possible.

1. Register a subdomain/get your subdomain

Run wrangler subdomain and see if you like the new output - try running wrangler subdomain <name> to register a subdomain (even if you already have) and note the output and if it makes sense.

2. Start a Workers Site from scratch

Beginning with nothing, let's build a Workers Site. Some HTML knowledge may be helpful for testers!

Docs: https://gist.github.com/ashleygwilliams/e8ab664e4a2a84b84fab2edebea07426#create-a-new-project-from-scratch

Tasks:

  • Deploy your new site to a Worker, either workers.dev or zoned.
  • Add a new page and a link to it from your index.html, then redeploy

3. Re-deploy your Workers Site without the images

Using the site you generated above, try to upload it without images; use the documentation at https://sites.workers-tooling.cf/workers/sites/ignore-assets/ as your guide.

This is to test that include/exclude logic works as expected.

4. Try to deploy workers with/without environments

Using wrangler publish, deploy a worker to both workers.dev and a bring your own domain w/routes. Please note anything that is confusing or any error messages you run into that could either be worded better or if there is a toml you think has a bit of unexpected behavior. See documentation here: https://github.com/cloudflare/wrangler/blob/master/docs/content/environments.md.

Note that you can no longer run wrangler publish --release, so if you have an old version of wrangler lying around, you may need to update your toml accordingly. You can also remove any top-level workers_dev = false from your wrangler.toml if there is a route and the route will be used.

See bugs?

If you run into bugs or think docs can be improved, please file a ticket at https://github.com/cloudflare/wrangler/issues :) Thank you so much for helping us prep our upcoming Wrangler release!

Changes:

  • 099cb53 1.5.0-rc.0
  • 71a7977 Merge pull request #764 from cloudflare/avery/simply-not-an-option
  • f519e91 Standardize get and put
  • be7130c Merge branch 'master' into avery/simply-not-an-option
  • f0920d4 Move put logic to Subdomain struct
  • de1f63f Merge pull request #751 from cloudflare/avery/release-the-kraken
  • 726e557 Add truth table comment for negotiate zoneless
  • 9d21619 Remove workers_dev from target creation
  • 912aed8 Clean up subdomain variables
  • 4c2840a Merge branch 'master' into avery/simply-not-an-option
See More
  • c8ae451 Merge branch 'master' into avery/release-the-kraken
  • 753d8f3 Exclude/include logic in wrangler.toml for static asset uploads (#760)
  • ab1464b Fix subdomain error message formatting
  • c00961e Merge branch 'master' into avery/simply-not-an-option
  • 96c333a Merge pull request #766 from bradyjoslin/fix-readme-typo
  • e610a25 remove duplicate Environments subheaders from readme
  • 306263f Use custom KV api client to support longer timeouts (#757)
  • 8f14831 Clean up subdomain creation
  • cc9d118 Merge pull request #763 from dottorblaster/fix-readme-markdown
  • 95a9c24 Merge branch 'master' into fix-readme-markdown
  • 7942c74 Merge branch 'master' into avery/release-the-kraken
  • 0ee69ab Merge pull request #747 from gusvargas/optional-subdomain-arg
  • f6cf4a2 Fix README markdown misrender
  • 1dd74e1 Simpler matching
  • c24969c match is the last expr in the fn
  • 50c873c Smaller get/set subdomoain functions for clarity
  • 46b5bf4 Get rid of nested if let statements
  • 493ee32 Merge branch 'master' into avery/release-the-kraken
  • b78c68c Merge branch 'master' into optional-subdomain-arg
  • bc74f97 Get env values on separate line
  • f0c692f Refactor site.rs calls to KV API (re-use commands::kv module logic) (#750)
  • 987a83e Merge branch 'master' into avery/release-the-kraken
  • fb74a8a Merge branch 'master' into optional-subdomain-arg
  • 82321cb Merge pull request #752 from cloudflare/ashleygwilliams-patch-1
  • 34f8080 Print subdomain if name arg not provided
  • a51ce87 list author as wrangler at cloudflare dot com
  • a403390 Merge branch 'master' into avery/release-the-kraken
  • 2f5e54b Deprecate release
  • 5e68600 Consistency in passing &GlobalUser (#749)
  • cf3ab74 Merge pull request #595 from cloudflare/1.4.0

This list of changes was auto generated.

Assets 6
Loading