From d5a1abb01391d8dcbf4958da8ef597fdcbee6966 Mon Sep 17 00:00:00 2001 From: James Ross Date: Mon, 25 Mar 2024 22:04:20 +0000 Subject: [PATCH 1/4] docs: remove warning about packageManager and pnpm default --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 6a8c3ec..20a53d4 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,6 @@ jobs: - name: Deploy uses: cloudflare/wrangler-action@v3 with: - packageManager: pnpm # you can omit this if you use npm apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} ``` @@ -53,10 +52,6 @@ jobs: ## Configuration -### packageManager - -⚠️ you must specify package manager. If not specified GH action assumes you are using npm and other managers might be failing. For example pnpm will fail with: `Cannot read properties of null (reading 'matches')` - 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 From 0c36639f724b6eef81496f852af57fe5275530de Mon Sep 17 00:00:00 2001 From: James Ross Date: Tue, 26 Mar 2024 00:31:15 +0000 Subject: [PATCH 2/4] docs: add brief docs about packageManager --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 20a53d4..82ea51f 100644 --- a/README.md +++ b/README.md @@ -268,6 +268,23 @@ The resulting output will look something like this: https://.pages.dev ``` +### Using a different package manager + +By default, this action will detect which package manager to use, based on the presence of a `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, or `bun.lockb` file. + +If you need to use a specific package manager for your application, you can set the `packageManager` input to `npm`, `yarn`, `pnpm`, or `bun`. You don't need to set this option unless you want to override the default behavior. + + +```yaml +jobs: + deploy: + steps: + uses: cloudflare/wrangler-action@v3 + with: + apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} + packageManager: pnpm +``` + ## Troubleshooting ### "I just started using Workers/Wrangler and I don't know what this is!" From f2c22accd39f68aa02cc06f766316769fe77afc1 Mon Sep 17 00:00:00 2001 From: Igor Minar Date: Tue, 26 Mar 2024 11:03:23 -0700 Subject: [PATCH 3/4] Update README.md remote ws --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 82ea51f..a0a6035 100644 --- a/README.md +++ b/README.md @@ -270,7 +270,7 @@ https://.pages.dev ### Using a different package manager -By default, this action will detect which package manager to use, based on the presence of a `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, or `bun.lockb` file. +By default, this action will detect which package manager to use, based on the presence of a `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, or `bun.lockb` file. If you need to use a specific package manager for your application, you can set the `packageManager` input to `npm`, `yarn`, `pnpm`, or `bun`. You don't need to set this option unless you want to override the default behavior. From 4bf3047bb891e129f1bc16001b66eb284e894c8a Mon Sep 17 00:00:00 2001 From: Igor Minar Date: Tue, 26 Mar 2024 11:07:50 -0700 Subject: [PATCH 4/4] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index a0a6035..201a5cd 100644 --- a/README.md +++ b/README.md @@ -274,7 +274,6 @@ By default, this action will detect which package manager to use, based on the p If you need to use a specific package manager for your application, you can set the `packageManager` input to `npm`, `yarn`, `pnpm`, or `bun`. You don't need to set this option unless you want to override the default behavior. - ```yaml jobs: deploy: