From 421f2e4b2811b0c3a4a3c36d2ccd6f25eba6146c Mon Sep 17 00:00:00 2001 From: Sunil Pai Date: Tue, 21 Dec 2021 19:30:02 +0000 Subject: [PATCH] Update base version to 0.0.5, copy the README to packages/wrangler (#152) --- .changeset/tasty-vans-reflect.md | 5 ++++ .github/workflows/release.yml | 2 +- package-lock.json | 2 +- packages/wrangler/CHANGELOG.md | 2 +- packages/wrangler/README.md | 51 ++++++++++++++++++++++++++++++++ packages/wrangler/package.json | 2 +- 6 files changed, 60 insertions(+), 4 deletions(-) create mode 100644 .changeset/tasty-vans-reflect.md create mode 100644 packages/wrangler/README.md diff --git a/.changeset/tasty-vans-reflect.md b/.changeset/tasty-vans-reflect.md new file mode 100644 index 000000000000..8fc0778f60b0 --- /dev/null +++ b/.changeset/tasty-vans-reflect.md @@ -0,0 +1,5 @@ +--- +"wrangler": patch +--- + +Update base version to 0.0.5, copy the README to packages/wrangler diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5a1681e8266d..e37d258c3395 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -40,7 +40,7 @@ jobs: id: changesets uses: changesets/action@v1 with: - publish: cp README.md packages/wrangler/README.md && npx changeset publish --tag beta + publish: npx changeset publish --tag beta env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_PUBLISH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} diff --git a/package-lock.json b/package-lock.json index 383a5069b89a..b2a0aa7e55e3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13452,7 +13452,7 @@ "license": "ISC" }, "packages/wrangler": { - "version": "0.0.0", + "version": "0.0.5", "license": "MIT OR Apache-2.0", "dependencies": { "@cloudflare/pages-functions-compiler": "0.3.8", diff --git a/packages/wrangler/CHANGELOG.md b/packages/wrangler/CHANGELOG.md index 8b8cfcc9e347..00acd0aace61 100644 --- a/packages/wrangler/CHANGELOG.md +++ b/packages/wrangler/CHANGELOG.md @@ -1,6 +1,6 @@ # wrangler -## 0.0.1 +## 0.0.5 ### Patch Changes diff --git a/packages/wrangler/README.md b/packages/wrangler/README.md new file mode 100644 index 000000000000..9b74d77bf583 --- /dev/null +++ b/packages/wrangler/README.md @@ -0,0 +1,51 @@ +## 🤠 wrangler + +`wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/). + +[(Read the full stack week launch blog post.)](https://blog.cloudflare.com/wrangler-v2-beta/) + +**DISCLAIMER**: This is a work in progress, and is NOT recommended for use in production. We are opening this preview for feedback from the community, and to openly share our [roadmap](https://github.com/cloudflare/wrangler2/issues/12) for the future. As such, expect APIs and documentation to change before the end of the preview. + +Further, we will NOT do a general release until we are both feature complete, and have a full backward compatibility and incremental migration plan in place. For more details, follow the [parent roadmap issue](https://github.com/cloudflare/wrangler2/issues/12). + +## Quick Start + +```bash +# Make a javascript file +$ echo "export default { fetch() { return new Response('hello world') } }" > index.js +# try it out +$ npx wrangler@beta dev index.js +# and then publish it +$ npx wrangler@beta publish index.js --name my-worker +# visit https://my-worker..workers.dev +``` + +## Installation: + +```bash +$ npm install wrangler@beta +``` + +## Commands + +### `wrangler init [name]` + +Creates a `wrangler.toml` configuration file. For more details on the configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration). + +### `wrangler dev [script]` + +Start a local development server, with live reloading and devtools. + +### `wrangler publish [script] --name [name]` + +Publish the given script to the worldwide Cloudflare network. + +For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands). + +### `wrangler pages dev [directory] [-- command]` + +Either serves a static build asset directory, or proxies itself in front of a command. + +Builds and runs functions from a `./functions` directory or uses a `_worker.js` file inside the static build asset directory. + +For more commands and options, refer to the [documentation](https://developers.cloudflare.com/pages/platform/functions#develop-and-preview-locally) or run `wrangler pages dev --help`. diff --git a/packages/wrangler/package.json b/packages/wrangler/package.json index 0bab4c299a65..339b6b2c5c7a 100644 --- a/packages/wrangler/package.json +++ b/packages/wrangler/package.json @@ -1,6 +1,6 @@ { "name": "wrangler", - "version": "0.0.1", + "version": "0.0.5", "author": "wrangler@cloudflare.com", "description": "Command-line interface for all things Cloudflare Workers", "bin": {