fixup! Delete .github/workflows/pullrequests.yml

Add `versions upload` instructions to README

.github/workflows/issues.yml

@@ -1,17 +0,0 @@
-name: Issue
-
-on:
-  issues:
-    types:
-      - opened
-      - transferred
-
-jobs:
-  add-to-project:
-    name: Add issue to workers-sdk GH project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@v0.5.0
-        with:
-          project-url: https://github.com/orgs/cloudflare/projects/1
-          github-token: ${{ secrets.GH_ACCESS_TOKEN }}

.github/workflows/pullrequests.yml

@@ -1,10 +0,0 @@
-name: Pull request
-
-on: pull_request
-
-jobs:
-  add-to-project:
-    name: Add PR to workers-sdk GH project
-    runs-on: ubuntu-latest
-    steps:
-      - run: curl -X POST https://devprod-status-bot.devprod.workers.dev/pr-project/wrangler-action/${{ github.event.number }}

.github/workflows/release.yml

@@ -20,6 +20,9 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          fetch-tags: true
 
       - name: Setup Node.js
         uses: actions/setup-node@v3

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 3.4.1
+
+### Patch Changes
+
+- [#227](https://github.com/cloudflare/wrangler-action/pull/227) [`bbedd8e54f256d36f81f81f1f05b90937d533bb7`](https://github.com/cloudflare/wrangler-action/commit/bbedd8e54f256d36f81f81f1f05b90937d533bb7) Thanks [@AdiRishi](https://github.com/AdiRishi)! - Surface inner exception when secret:bulk upload command fails
+
+## 3.4.0
+
+### Minor Changes
+
+- [#213](https://github.com/cloudflare/wrangler-action/pull/213) [`d13856dfc92816473ebf47f66e263a2668a97896`](https://github.com/cloudflare/wrangler-action/commit/d13856dfc92816473ebf47f66e263a2668a97896) Thanks [@GrantBirki](https://github.com/GrantBirki)! - This change introduces three new GitHub Actions output variables. These variables are as follows:
+
+  - `command-output` - contains the string results of `stdout`
+  - `command-stderr` - contains the string results of `stderr`
+  - `deployment-url` - contains the string results of the URL that was deployed (ex: `https://<your_pages_site>.pages.dev`)
+
+  These output variables are intended to be used by more advanced workflows that require the output results or deployment url from Wrangler commands in subsequent workflow steps.
+
+### Patch Changes
+
+- [#216](https://github.com/cloudflare/wrangler-action/pull/216) [`9aba9c34daabca23a88191a5fe1b81fa721c1f11`](https://github.com/cloudflare/wrangler-action/commit/9aba9c34daabca23a88191a5fe1b81fa721c1f11) Thanks [@Cherry](https://github.com/Cherry)! - Fixes issues with semver comparison, where version parts were treated lexicographically instead of numerically.
+
+  Bulk secret uploading was introduced in wrangler `3.4.0`, and this action tries to check if the version used is greater than `3.4.0`, and then if so, using the new bulk secret API which is faster. Due to a bug in the semver comparison, `3.19.0` was being considered less than `3.4.0`, and then using an older and slower method for uploading secrets.
+
+  Now the semver comparison is fixed, the faster bulk method is used for uploading secrets when available.
+
 ## 3.3.2
 
 ### Patch Changes

README.md

@@ -27,18 +27,18 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Deploy
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 ## Authentication
 
-You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API token (for help finding this, see the [Workers documentation](https://developers.cloudflare.com/workers/quickstart/#api-token)). Your API token is encrypted by GitHub, and the action won't print it into logs, so it should be safe!
+You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API token (for help finding this, see the [Workers documentation](https://developers.cloudflare.com/workers/wrangler/ci-cd/#api-token)). Your API token is encrypted by GitHub, and the action won't print it into logs, so it should be safe!
 
-With your API token set as a secret for your repository, pass it to the action in the `with` block of your workflow. Below, I've set the secret name to `CF_API_TOKEN`:
+With your API token set as a secret for your repository, pass it to the action in the `with` block of your workflow. Below, I've set the secret name to `CLOUDFLARE_API_TOKEN`:
 
 ```yaml
 jobs:
@@ -47,7 +47,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 ## Configuration
@@ -60,7 +60,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         wranglerVersion: "2.20.0"
 ```
 
@@ -72,7 +72,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         workingDirectory: "subfoldername"
 ```
 
@@ -84,7 +84,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         secrets: |
           SECRET1
           SECRET2
@@ -101,7 +101,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         preCommands: echo "*** pre command ***"
         postCommands: |
           echo "*** post commands ***"
@@ -117,7 +117,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         command: whoami
 ```
 
@@ -138,11 +138,11 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Deploy
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 Note that there are a number of possible events, like `push`, that can be used to trigger a workflow. For more details on the events available, refer to the [GitHub Actions documentation](https://help.github.com/en/articles/workflow-syntax-for-github-actions#on).
@@ -159,12 +159,12 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Deploy
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
-          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
           command: pages deploy --project-name=example
 ```
 
@@ -182,11 +182,11 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Deploy app
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 If you need help defining the correct cron syntax, check out [crontab.guru](https://crontab.guru/), which provides a friendly user interface for validating your cron schedule.
@@ -208,16 +208,101 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Deploy app
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           command: deploy --env ${{ github.event.inputs.environment }}
 ```
 
 For more advanced usage or to programmatically trigger the workflow from scripts, refer to [the GitHub documentation](https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event) for making API calls.
 
+### Upload a Worker Version
+
+To create a new version of your Worker that is not deployed immediately, use the `wrangler versions upload --experimental-versions` command. Worker versions created in this way can then be deployed all at once at a later time or gradually deployed using the `wranger versions deploy --experimental-versions` command or via the Cloudflare dashboard under the Deployments tab. For now, the `--experimental-versions` flag and wrangler v3.40.0 or above is required to use this feature.
+
+```yaml
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - uses: actions/checkout@v4
+      - name: Upload Worker Version
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: versions upload --experimental-versions
+```
+
+## Advanced Usage
+
+### Using Wrangler Command Output in Subsequent Steps
+
+More advanced workflows may need to parse the resulting output of Wrangler commands. To do this, you can use the `command-output` output variable in subsequent steps. For example, if you want to print the output of the Wrangler command, you can do the following:
+
+```yaml
+- name: Deploy
+  id: deploy
+  uses: cloudflare/wrangler-action@v3
+  with:
+    apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+    accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+    command: pages deploy --project-name=example
+
+- name: print wrangler command output
+  env:
+    CMD_OUTPUT: ${{ steps.deploy.outputs.command-output }}
+  run: echo $CMD_OUTPUT
+```
+
+Now when you run your workflow, you will see the full output of the Wrangler command in your workflow logs. You can also use this output in subsequent workflow steps to parse the output for specific values.
+
+> Note: the `command-stderr` output variable is also available if you need to parse the standard error output of the Wrangler command.
+
+### Using the `deployment-url` Output Variable
+
+If you are executing a Wrangler command that results in either a Workers or Pages deployment, you can utilize the `deployment-url` output variable to get the URL of the deployment. For example, if you want to print the deployment URL after deploying your application, you can do the following:
+
+```yaml
+- name: Deploy
+  id: deploy
+  uses: cloudflare/wrangler-action@v3
+  with:
+    apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+    accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+    command: pages deploy --project-name=example
+
+- name: print deployment-url
+  env:
+    DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
+  run: echo $DEPLOYMENT_URL
+```
+
+The resulting output will look something like this:
+
+```text
+https://<your_pages_site>.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!"
@@ -236,10 +321,10 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Deploy app
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
-          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
 ```

action.yml

@@ -44,3 +44,10 @@ inputs:
   packageManager:
     description: "The package manager you'd like to use to install and run wrangler. If not specified, the preferred package manager will be inferred based on the presence of a lockfile or fallback to using npm if no lockfile is found. Valid values are `npm` | `pnpm` | `yarn` | `bun`."
     required: false
+outputs:
+  command-output:
+    description: "The output of the Wrangler command (comes from stdout)"
+  command-stderr:
+    description: "The error output of the Wrangler command (comes from stderr)"
+  deployment-url:
+    description: "If the command was a Workers or Pages deployment, this will be the URL of the deployment"

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wrangler-action",
-	"version": "3.3.2",
+	"version": "3.4.1",
 	"description": "GitHub Action to use [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/).",
 	"author": "wrangler@cloudflare.com",
 	"license": "MIT OR Apache-2.0",
@@ -29,17 +29,18 @@
 		"check": "prettier --check ."
 	},
 	"dependencies": {
-		"@actions/core": "^1.10.0",
+		"@actions/core": "^1.10.1",
 		"@actions/exec": "^1.1.1"
 	},
 	"devDependencies": {
 		"@changesets/changelog-github": "^0.4.8",
 		"@changesets/cli": "^2.26.2",
-		"@cloudflare/workers-types": "^4.20230814.0",
-		"@types/node": "^20.5.0",
-		"@vercel/ncc": "^0.36.1",
-		"prettier": "^3.0.1",
-		"typescript": "^5.1.6",
-		"vitest": "^0.34.1"
+		"@cloudflare/workers-types": "^4.20231121.0",
+		"@types/node": "^20.10.4",
+		"@vercel/ncc": "^0.38.1",
+		"prettier": "^3.1.0",
+		"semver": "^7.5.4",
+		"typescript": "^5.3.3",
+		"vitest": "^1.0.3"
 	}
 }

src/index.ts

@@ -5,8 +5,10 @@ import {
 	endGroup as originalEndGroup,
 	error as originalError,
 	info as originalInfo,
+	debug,
 	startGroup as originalStartGroup,
 	setFailed,
+	setOutput,
 } from "@actions/core";
 import { exec, execShell } from "./exec";
 import { checkWorkingDirectory, semverCompare } from "./utils";
@@ -203,7 +205,11 @@ async function uploadSecrets() {
 				),
 			),
 		});
-	} catch (err) {
+	} catch (err: unknown) {
+		if (err instanceof Error) {
+			error(err.message);
+			err.stack && debug(err.stack);
+		}
 		throw new Error(`Failed to upload secrets.`);
 	} finally {
 		endGroup();
@@ -242,10 +248,46 @@ async function wranglerCommands() {
 				}
 			}
 
-			await exec(`${packageManager.exec} wrangler ${command}`, args, {
+			// Used for saving the wrangler output
+			let stdOut = "";
+			let stdErr = "";
+
+			// Construct the options for the exec command
+			const options = {
 				cwd: config["workingDirectory"],
 				silent: config["QUIET_MODE"],
-			});
+				listeners: {
+					stdout: (data: Buffer) => {
+						stdOut += data.toString();
+					},
+					stderr: (data: Buffer) => {
+						stdErr += data.toString();
+					},
+				},
+			};
+
+			// Execute the wrangler command
+			await exec(`${packageManager.exec} wrangler ${command}`, args, options);
+
+			// Set the outputs for the command
+			setOutput("command-output", stdOut);
+			setOutput("command-stderr", stdErr);
+
+			// Check if this command is a workers or pages deployment
+			if (
+				command.startsWith("deploy") ||
+				command.startsWith("publish") ||
+				command.startsWith("pages publish") ||
+				command.startsWith("pages deploy")
+			) {
+				// If this is a workers or pages deployment, try to extract the deployment URL
+				let deploymentUrl = "";
+				const deploymentUrlMatch = stdOut.match(/https?:\/\/[a-zA-Z0-9-./]+/);
+				if (deploymentUrlMatch && deploymentUrlMatch[0]) {
+					deploymentUrl = deploymentUrlMatch[0].trim();
+					setOutput("deployment-url", deploymentUrl);
+				}
+			}
 		}
 	} finally {
 		endGroup();

src/utils.test.ts

@@ -26,7 +26,30 @@ describe("checkWorkingDirectory", () => {
 		expect(() =>
 			checkWorkingDirectory("/does/not/exist"),
 		).toThrowErrorMatchingInlineSnapshot(
-			'"Directory /does/not/exist does not exist."',
+			`[Error: Directory /does/not/exist does not exist.]`,
 		);
 	});
 });
+
+describe("semverCompare", () => {
+	test.each([
+		["1.2.3", "1.2.3", false],
+		["1.2.2", "1.2.3", true],
+		["2.0.0", "3.0.0", true],
+		["3.1.0", "3.1.1", true],
+		["3.1.0", "3.5.0", true],
+		["3.1.0", "3.10.0", true],
+		["3.1.0", "3.15.0", true],
+		["3.10.0", "3.1.0", false],
+		["3.20.0", "3.2.0", false],
+		["3.1.0", "latest", true],
+		["4.0.0", "latest", true],
+	])(
+		"should semver compare %s vs %s correctly, expecting %s",
+		(version1, version2, expected) => {
+			const isVersion1LessThanVersion2 = semverCompare(version1, version2);
+
+			expect(isVersion1LessThanVersion2).toBe(expected);
+		},
+	);
+});

src/utils.ts

@@ -1,5 +1,6 @@
 import { existsSync } from "node:fs";
 import * as path from "node:path";
+import semverGt from "semver/functions/gt";
 
 /**
  * A helper function to compare two semver versions. If the second arg is greater than the first arg, it returns true.
@@ -7,18 +8,7 @@ import * as path from "node:path";
 export function semverCompare(version1: string, version2: string) {
 	if (version2 === "latest") return true;
 
-	const version1Parts = version1.split(".");
-	const version2Parts = version2.split(".");
-
-	for (const version1Part of version1Parts) {
-		const version2Part = version2Parts.shift();
-
-		if (version1Part !== version2Part && version2Part) {
-			return version1Part < version2Part ? true : false;
-		}
-	}
-
-	return false;
+	return semverGt(version2, version1);
 }
 
 export function checkWorkingDirectory(workingDirectory = ".") {