Merge pull request #119 from cloudflare/jacobmgevans/remove-v1-examples

Update README to remove v1 suggestions/examples
This commit is contained in:
Jacob M-G Evans 2023-08-07 13:30:09 -05:00 committed by GitHub
commit 0c419bee6c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,6 +2,7 @@
Easy-to-use GitHub Action to use [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/). Makes deploying Workers, Pages or modifying R2 easy to do. Easy-to-use GitHub Action to use [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/). Makes deploying Workers, Pages or modifying R2 easy to do.
Wrangler v1 is longer supported.
[Refer to Changelog for more information](CHANGELOG.md). [Refer to Changelog for more information](CHANGELOG.md).
## Usage ## Usage
@ -59,7 +60,7 @@ jobs:
## Configuration ## Configuration
If you need to install a specific version of Wrangler to use for deployment, you can also pass the input `wranglerVersion` to install a specific version of Wrangler from NPM. This should be a [SemVer](https://semver.org/)-style version number, such as `1.6.0`: If you need to install a specific version of Wrangler to use for deployment, you can also pass the input `wranglerVersion` to install a specific version of Wrangler from NPM. This should be a [SemVer](https://semver.org/)-style version number, such as `2.20.0`:
```yaml ```yaml
jobs: jobs:
@ -68,7 +69,7 @@ jobs:
uses: cloudflare/wrangler-action@3.0.0 uses: cloudflare/wrangler-action@3.0.0
with: with:
apiToken: ${{ secrets.CF_API_TOKEN }} apiToken: ${{ secrets.CF_API_TOKEN }}
wranglerVersion: "1.6.0" wranglerVersion: "2.20.0"
``` ```
Optionally, you can also pass a `workingDirectory` key to the action. This will allow you to specify a subdirectory of the repo to run the Wrangler command from. Optionally, you can also pass a `workingDirectory` key to the action. This will allow you to specify a subdirectory of the repo to run the Wrangler command from.