Merge branch 'main' into threepointone-patch-1

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
+	"changelog": [
+		"@changesets/changelog-github",
+		{ "repo": "cloudflare/wrangler-action" }
+	],
+	"commit": false,
+	"linked": [],
+	"access": "public",
+	"baseBranch": "main",
+	"updateInternalDependencies": "patch",
+	"ignore": []
+}

.github/workflows/deploy.yml

@@ -1,91 +1,164 @@
-on: push
+name: Wrangler Action Self Testing
+on:
+  pull_request:
+    branches:
+      - main
 
 jobs:
-  lint:
+  wrangler_action_self_testing:
     runs-on: ubuntu-latest
-    name: Lint
     steps:
-    - uses: actions/checkout@v2
-    - name: Lint shell script
-      uses: azohra/shell-linter@v0.3.0
-      with:
-        path: "entrypoint.sh"
-  build-only:
-    runs-on: ubuntu-latest
-    name: Only build the app
-    steps:
-      - uses: actions/checkout@v2
-      - name: Build app
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "latest"
+          cache: "npm"
+
+      - name: Install modules and build
+        run: npm ci && npm run build
+
+      - name: Unit Tests
+        run: npm run test
+
+      - name: Check Formatting
+        run: npm run check
+
+      - name: Only build app
         uses: ./
         with:
+          workingDirectory: "./test/only-build"
           apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          workingDirectory: "test"
-          publish: false
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: deploy --dry-run
+
+      - name: Only build app w/ quiet enabled
+        uses: ./
+        with:
+          quiet: true
+          workingDirectory: "./test/build-quiet"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: deploy --dry-run
+
+      - name: Environment support
+        uses: ./
+        with:
+          workingDirectory: "./test/environment"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          environment: dev
+          preCommands: npx wrangler deploy --env dev # https://github.com/cloudflare/wrangler-action/issues/162
+          postCommands: npx wrangler delete --name wrangler-action-dev-environment-test --force
           secrets: |
             SECRET1
             SECRET2
-          preCommands: echo "*** pre commands ***"
-          postCommands: |
-            echo "*** post commands ***"
-            wrangler build
-            echo "******"
         env:
           SECRET1: ${{ secrets.SECRET1 }}
           SECRET2: ${{ secrets.SECRET2 }}
-  publish:
-    runs-on: ubuntu-latest
-    name: Publish app
-    steps:
-    - uses: actions/checkout@v2
-    - name: Publish app
-      uses: ./
-      with:
-        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-        environment: "production"
-        workingDirectory: 'test'
-  publish_legacy_credentials:
-    runs-on: ubuntu-latest
-    name: Publish app with legacy credentials
-    steps:
-    - uses: actions/checkout@v2
-    - name: Publish app
-      uses: ./
-      with:
-        apiKey: ${{ secrets.CLOUDFLARE_API_KEY }}
-        email: ${{ secrets.CLOUDFLARE_EMAIL }}
-        environment: "production"
-        workingDirectory: 'test'
-  publish_hardcoded_wrangler_version:
-    runs-on: ubuntu-latest
-    name: Publish app with hardcoded Wrangler version
-    steps:
-    - uses: actions/checkout@v2
-    - name: Publish app
-      uses: ./
-      with:
-        apiKey: ${{ secrets.CLOUDFLARE_API_KEY }}
-        email: ${{ secrets.CLOUDFLARE_EMAIL }}
-        environment: "production"
-        wranglerVersion: '1.5.0'
-        workingDirectory: 'test'
-  publish_secrets:
-    runs-on: ubuntu-latest
-    name: Publish app with secrets
-    steps:
-      - uses: actions/checkout@v2
-      - name: Publish app
+
+      # START Setup and teardown of Workers w/ Secrets Tests
+      - name: Deploy app secrets w/ hardcoded Wrangler v2
         uses: ./
         with:
+          wranglerVersion: "2.20.0"
+          workingDirectory: "./test/secrets-v2"
           apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          environment: "production"
-          workingDirectory: "test"
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
           secrets: |
             SECRET1
             SECRET2
-          preCommands: echo "*** pre command ***"
-          postCommands: |
-            echo "*** post commands ***"
-            echo "******"
         env:
           SECRET1: ${{ secrets.SECRET1 }}
-          SECRET2: ${{ secrets.SECRET2 }}
+          SECRET2: ${{ secrets.SECRET2 }}
+
+      - name: Health Check Deployed Worker
+        run: node .github/workflows/workerHealthCheck.cjs wrangler-action-test-secrets-v2
+        shell: bash
+
+      - name: Deploy app secrets w/ default version
+        uses: ./
+        with:
+          workingDirectory: "./test/secrets-default"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          secrets: |
+            SECRET1
+            SECRET2
+        env:
+          SECRET1: ${{ secrets.SECRET1 }}
+          SECRET2: ${{ secrets.SECRET2 }}
+
+      - name: Health Check Deployed Worker
+        run: node .github/workflows/workerHealthCheck.cjs wrangler-action-test-secrets-default
+        shell: bash
+
+      - name: Clean Up Deployed Workers
+        uses: ./
+        with:
+          workingDirectory: "./test/secrets-default"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: delete --name wrangler-action-test-secrets-v2 --force
+          postCommands: npx wrangler delete --name wrangler-action-test-secrets-default --force
+      # END Setup and teardown of Workers w/ Secrets Tests
+
+      - name: Support packageManager variable
+        uses: ./
+        with:
+          workingDirectory: "./test/specify-package-manager"
+          packageManager: "npm"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: deploy --dry-run
+
+      - name: Support unspecified packageManager with no lockfile
+        uses: ./
+        with:
+          workingDirectory: "./test/unspecified-package-manager"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: deploy --dry-run
+
+      - name: Support npm package manager
+        uses: ./
+        with:
+          workingDirectory: "./test/npm"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: deploy --dry-run
+
+      - name: Install yarn
+        run: npm i -g yarn
+
+      - name: Support yarn package manager
+        uses: ./
+        with:
+          workingDirectory: "./test/yarn"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: deploy --dry-run
+
+      - name: Install pnpm
+        run: npm i -g pnpm
+
+      - name: Support pnpm package manager
+        uses: ./
+        with:
+          workingDirectory: "./test/pnpm"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: deploy --dry-run
+
+      - name: Change directory to pre-installed-wrangler and install dependencies
+        run: |
+          cd ./test/pre-installed-wrangler
+          npm install
+
+      - name: Support pre-installed wrangler
+        uses: ./
+        with:
+          workingDirectory: "./test/pre-installed-wrangler"
+          command: action-test

.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    if: ${{ github.repository_owner == 'cloudflare' }}
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+      pull-requests: write
+      issues: read
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "latest"
+          cache: "npm"
+
+      - name: Install modules
+        run: npm ci
+
+      - name: Create Version PR
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          createGithubReleases: true
+          publish: npx changeset tag
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build action
+        if: steps.changesets.outputs.published == 'true'
+        run: npm run build
+
+      - name: Push dist-tags
+        if: steps.changesets.outputs.published == 'true'
+        uses: JasonEtco/build-and-tag-action@v2
+        with:
+          tag_name: v${{ fromJSON(steps.changesets.outputs.publishedPackages)[0].version }}
+        env:
+          GITHUB_TOKEN: ${{ github.token }}

.github/workflows/workerHealthCheck.cjs

@@ -0,0 +1,28 @@
+const { execSync } = require("child_process");
+
+function workerHealthCheck(workerName) {
+	const url = `https://${workerName}.devprod-testing7928.workers.dev/secret-health-check`;
+
+	const buffer = execSync(`curl ${url}`);
+
+	const response = buffer.toString();
+
+	if (response.includes("OK")) {
+		console.log(`Status: Worker is up! Response: ${response}`);
+	} else {
+		throw new Error(`Worker is down! Response: ${response}`);
+	}
+
+	return response;
+}
+
+const args = Array.from(process.argv);
+const workerName = args.pop();
+
+if (!workerName) {
+	throw new Error(
+		"Please provide the worker name as an argument when calling this program.",
+	);
+}
+
+workerHealthCheck(workerName);

.gitignore

@@ -0,0 +1,95 @@
+dist
+.idea
+.vscode
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+node_modules
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+
+# Moved from ./templates for ignoring all locks in templates
+templates/**/*-lock.*
+templates/**/*.lock
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+

.prettierignore

@@ -0,0 +1 @@
+pnpm-lock.yaml

.prettierrc

@@ -0,0 +1,6 @@
+{
+	"printWidth": 80,
+	"singleQuote": false,
+	"semi": true,
+	"useTabs": true
+}

CHANGELOG.md

@@ -1,23 +1,173 @@
-# 2.0.0 (Breaking update)
+# Changelog
 
-## Additions
+## 3.6.0
 
-* New `command` input
-    * This allows you to specify the Wrangler command you would like to run.
+### Minor Changes
+
+- [#235](https://github.com/cloudflare/wrangler-action/pull/235) [`0545ad285acaff2b92053d636ee17fb303b4c5f5`](https://github.com/cloudflare/wrangler-action/commit/0545ad285acaff2b92053d636ee17fb303b4c5f5) Thanks [@AdiRishi](https://github.com/AdiRishi)! - wrangler-action will now re-use existing wrangler installations when available
+
+## 3.5.0
+
+### Minor Changes
+
+- [#255](https://github.com/cloudflare/wrangler-action/pull/255) [`31a6263ef3ec73ff2d03cb4c0260379f96f7598c`](https://github.com/cloudflare/wrangler-action/commit/31a6263ef3ec73ff2d03cb4c0260379f96f7598c) Thanks [@matthewdavidrodgers](https://github.com/matthewdavidrodgers)! - Stop racing secret uploads
+
+  For up to date versions of wrangler, secrets are uploaded via the 'secret:bulk' command, which batches updates in a single API call.
+
+  For versions of wrangler without that capability, the action falls back to the single 'secret put' command for each secret. It races all these with a Promise.all()
+
+  Unfortunately, the single secret API cannot handle concurrency - at best, these calls have to wait on one another, holding requests open all the while. Often it times out and errors.
+
+  This fixes the legacy secret upload errors by making these calls serially instead of concurrently.
+
+## 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
+
+- [#171](https://github.com/cloudflare/wrangler-action/pull/171) [`76d614f`](https://github.com/cloudflare/wrangler-action/commit/76d614f400bd92237ed23c3df559f2c31b14a790) Thanks [@1000hz](https://github.com/1000hz)! - Fixed issues that caused the action to fail if any secret or var values contained shell metacharacters.
+
+- [#171](https://github.com/cloudflare/wrangler-action/pull/171) [`473d9cb`](https://github.com/cloudflare/wrangler-action/commit/473d9cbd296528b41c653af10062faba6540a7ab) Thanks [@1000hz](https://github.com/1000hz)! - Bumped `DEFAULT_WRANGLER_VERSION` to 3.13.2
+
+## 3.3.1
+
+### Patch Changes
+
+- [#193](https://github.com/cloudflare/wrangler-action/pull/193) [`a4509d5`](https://github.com/cloudflare/wrangler-action/commit/a4509d507c62dd7f49fba7df7d2db3997222393a) Thanks [@1000hz](https://github.com/1000hz)! - Fixed the package manager not being inferred based on lockfile when the `packageManager` input isn't set.
+
+## 3.3.0
+
+### Minor Changes
+
+- [#188](https://github.com/cloudflare/wrangler-action/pull/188) [`d9a0a00`](https://github.com/cloudflare/wrangler-action/commit/d9a0a00f8bc502ceea2a60e5af258416b35a85b9) Thanks [@simpleauthority](https://github.com/simpleauthority)! - Added support for Bun as a package manager
+
+## 3.2.1
+
+### Patch Changes
+
+- [#190](https://github.com/cloudflare/wrangler-action/pull/190) [`528687a`](https://github.com/cloudflare/wrangler-action/commit/528687aaf436f67565918533ffd15c250f39c47b) Thanks [@1000hz](https://github.com/1000hz)! - Fixed action failure when no `packageManager` specified and no lockfile is found. The action now falls back to using npm.
+
+## 3.2.0
+
+### Minor Changes
+
+- [#166](https://github.com/cloudflare/wrangler-action/pull/166) [`7d7b988`](https://github.com/cloudflare/wrangler-action/commit/7d7b98826e14e9ad422870a7263b7074b40bf16f) Thanks [@nix6839](https://github.com/nix6839)! - Support for package managers other than npm, such as pnpm and yarn.
+
+  fixes #156
+
+## 3.1.1
+
+### Patch Changes
+
+- [#161](https://github.com/cloudflare/wrangler-action/pull/161) [`e5251df`](https://github.com/cloudflare/wrangler-action/commit/e5251df52154e9ebc98edb02ee0598c7210dcf0f) Thanks [@1000hz](https://github.com/1000hz)! - Refactored error handling to stop execution when action fails. Previously, the action would continue executing to completion if one of the steps encountered an error. Fixes #160.
+
+## 3.1.0
+
+### Minor Changes
+
+- [#154](https://github.com/cloudflare/wrangler-action/pull/154) [`3f40637`](https://github.com/cloudflare/wrangler-action/commit/3f40637a1c48016d2101e412a7a06f1eb4b9c2fd) Thanks [@JacobMGEvans](https://github.com/JacobMGEvans)! - feat: Quiet mode
+  Some of the stderr, stdout, info & groupings can be a little noisy for some users and use cases.
+  This feature allows for a option to be passed 'quiet: true' this would significantly reduce the noise.
+
+  There will still be output that lets the user know Wrangler Installed and Wrangler Action completed successfully.
+  Any failure status will still be output to the user as well, to prevent silent failures.
+
+  resolves #142
+
+## 3.0.2
+
+### Patch Changes
+
+- [#147](https://github.com/cloudflare/wrangler-action/pull/147) [`58f274b`](https://github.com/cloudflare/wrangler-action/commit/58f274b9f70867447519c6fa983c813e2b167b85) Thanks [@JacobMGEvans](https://github.com/JacobMGEvans)! - Added more error logging when a command fails to execute
+  Previously, we prevented any error logs from propagating too far to prevent leaking of any potentially sensitive information. However, this made it difficult for developers to debug their code.
+
+  In this release, we have updated our error handling to allow for more error messaging from pre/post and custom commands. We still discourage the use of these commands for secrets or other sensitive information, but we believe this change will make it easier for developers to debug their code.
+
+  Relates to #137
+
+- [#147](https://github.com/cloudflare/wrangler-action/pull/147) [`58f274b`](https://github.com/cloudflare/wrangler-action/commit/58f274b9f70867447519c6fa983c813e2b167b85) Thanks [@JacobMGEvans](https://github.com/JacobMGEvans)! - Adding Changesets
+
+- [Version 3.0.0](#version-300)
+- [Version 2.0.0](#version-200)
+
+## Version 3.0.0 (Breaking update)
+
+### Additions
+
+- **Rewritten Wrangler Action in TypeScript.**
+- Bulk secrets API utilization from Wrangler.
+- Added testing for improved reliability.
+- Implemented multiline support for the `command` input to allow running multiple Wrangler commands.
+- Now using Node for the Action engine/runner.
+- Open discussions with the community on all changes through GitHub Discussions and monitored Issues.
+
+### Removals
+
+- Removed Docker as a dependency.
+- Dropped support for Wrangler v1.
+
+### Changes
+
+- Fixed CI/CD issues.
+
+### Breaking changes
+
+- Wrangler v1 is no longer supported.
+  - Please update to the latest version of Wrangler.
+- Updated default version of Wrangler to v3.4.0
+
+### Additional Notes
+
+- Major Version Default: [DEVX-632](https://jira.cfdata.org/browse/DEVX-632)
+- Rewrite Project Tickets: [DEVX-804](https://jira.cfdata.org/browse/DEVX-804), [DEVX-802](https://jira.cfdata.org/browse/DEVX-802), [DEVX-800](https://jira.cfdata.org/browse/DEVX-800), [DEVX-632](https://jira.cfdata.org/browse/DEVX-632)
+
+---
+
+## Version 2.0.0 (Breaking update)
+
+### Additions
+
+- New `command` input
+  - This allows you to specify the Wrangler command you would like to run.
     For example, if you want to publish the production version of your Worker you may run `publish --env=production`.
-    * This opens up other possibilities too like publishing a Pages project: `pages publish <directory> --project-name=<name>`.
-* New `accountId` input
-  * This allows you to specify your account ID.
+  - This opens up other possibilities too like publishing a Pages project: `pages publish <directory> --project-name=<name>`.
+- New `accountId` input
+  - This allows you to specify your account ID.
 
-## Removals
+### Removals
 
-* Removed `publish` input (refer to [Breaking changes](#breaking-changes)).
+- Removed `publish` input (refer to [Breaking changes](#breaking-changes)).
 
-## Changes
+### Changes
 
 -- no changes --
 
-## __Breaking changes__
+### Breaking changes
 
-* `publish` has been removed.
-  * You should instead do `command: publish`.
+- `publish` has been removed.
+  - You should instead do `command:

CODEOWNERS

@@ -0,0 +1,4 @@
+* @cloudflare/wrangler @cloudflare/banda-team
+
+
+CHANGELOG.md @cloudflare/wrangler-admins @cloudflare/banda-team

Dockerfile

@@ -1,7 +0,0 @@
-FROM node:16
-ENV XDG_CONFIG_HOME /github/workspace
-ENV WRANGLER_HOME /github/workspace
-
-COPY entrypoint.sh /entrypoint.sh
-
-ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,12 +1,18 @@
 # Wrangler GitHub Action
 
-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 a breeze.
+
+## Big Changes in v3
+
+- Wrangler v1 is no longer supported.
+- Global API key & Email Auth no longer supported
+- Action version syntax is newly supported. This means e.g. `uses: cloudflare/wrangler-action@v3`, `uses: cloudflare/wrangler-action@v3.x`, and `uses: cloudflare/wrangler-action@v3.x.x` are all now valid syntax. Previously supported syntax e.g. `uses: cloudflare/wrangler-action@3.x.x` is no longer supported -- the prefix `v` is now necessary.
 
 [Refer to Changelog for more information](CHANGELOG.md).
 
 ## Usage
 
-Add `wrangler-action` to the workflow for your Workers/Pages application. The below example will publish a Worker on a `git push` to the `main` branch:
+Add `wrangler-action` to the workflow for your Workers/Pages application. The below example will deploy a Worker on a `git push` to the `main` branch:
 
 ```yaml
 name: Deploy
@@ -21,54 +27,41 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v2
-      - name: Publish
-        uses: cloudflare/wrangler-action@2.0.0
+      - 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:
   deploy:
     name: Deploy
     steps:
-      uses: cloudflare/wrangler-action@2.0.0
+      uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
-```
-
-`wrangler-action` also supports using your [global API key and email](https://developers.cloudflare.com/workers/quickstart/#global-api-key) as an authentication method, although API tokens are preferred. Pass in `apiKey` and `email` to the GitHub Action to use this method:
-
-```yaml
-jobs:
-  deploy:
-    name: Deploy
-    steps:
-      uses: cloudflare/wrangler-action@2.0.0
-      with:
-        apiKey: ${{ secrets.CF_API_KEY }}
-        email: ${{ secrets.CF_EMAIL }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 ## 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
 jobs:
   deploy:
     steps:
-      uses: cloudflare/wrangler-action@2.0.0
+      uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
-        wranglerVersion: '1.6.0'
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        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.
@@ -77,38 +70,38 @@ Optionally, you can also pass a `workingDirectory` key to the action. This will
 jobs:
   deploy:
     steps:
-      uses: cloudflare/wrangler-action@2.0.0
+      uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
-        workingDirectory: 'subfoldername'
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        workingDirectory: "subfoldername"
 ```
 
-[Worker secrets](https://developers.cloudflare.com/workers/tooling/wrangler/secrets/) can be optionally passed as a new line deliminated string of names in `secrets`.  Each secret name must match an environment variable name specified in the `env` attribute.  Creates or replaces the value for the Worker secret using the `wrangler secret put` command.
+[Worker secrets](https://developers.cloudflare.com/workers/tooling/wrangler/secrets/) can optionally be passed in via `secrets` as a string of names separated by newlines. Each secret name must match the name of an environment variable specified in the `env` field. This creates or replaces the value for the Worker secret using the `wrangler secret put` command.
 
 ```yaml
 jobs:
   deploy:
     steps:
-      uses: cloudflare/wrangler-action@2.0.0
+      uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         secrets: |
-            SECRET1
-            SECRET2
+          SECRET1
+          SECRET2
       env:
         SECRET1: ${{ secrets.SECRET1 }}
         SECRET2: ${{ secrets.SECRET2 }}
 ```
 
-If you need to run additional shell commands before or after your command, you can specify them as input to `preCommands` (before `publish`) or `postCommands` (after `publish`). These can include additional `wrangler` commands (that is, `whoami`, `kv:key put`) or any other commands available inside the `wrangler-action` context.
+If you need to run additional shell commands before or after your command, you can specify them as input to `preCommands` (before `deploy`) or `postCommands` (after `deploy`). These can include additional `wrangler` commands (that is, `whoami`, `kv:key put`) or any other commands available inside the `wrangler-action` context.
 
 ```yaml
 jobs:
   deploy:
     steps:
-      uses: cloudflare/wrangler-action@2.0.0
+      uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         preCommands: echo "*** pre command ***"
         postCommands: |
           echo "*** post commands ***"
@@ -122,9 +115,9 @@ You can use the `command` option to do specific actions such as running `wrangle
 jobs:
   deploy:
     steps:
-      uses: cloudflare/wrangler-action@2.0.0
+      uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         command: whoami
 ```
 
@@ -145,18 +138,18 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
-      - name: Publish
-        uses: cloudflare/wrangler-action@2.0.0
+      - 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).
 
 ### Deploy your Pages site (production & preview)
 
-If you want to deploy your Pages project with GitHub Actions rather than the built-in continous integration (CI), then this is a great way to do it. Wrangler 2 will populate the commit message and branch for you. You only need to pass the project name. If a push to a non-production branch is done, it will publish as a preview deployment:
+If you want to deploy your Pages project with GitHub Actions rather than the built-in continous integration (CI), then this is a great way to do it. Wrangler 2 will populate the commit message and branch for you. You only need to pass the project name. If a push to a non-production branch is done, it will deploy as a preview deployment:
 
 ```yaml
 on: [push]
@@ -166,13 +159,13 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
-      - name: Publish
-        uses: cloudflare/wrangler-action@2.0.0
+      - uses: actions/checkout@v4
+      - name: Deploy
+        uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
-          accountId: ${{ secrets.CF_ACCOUNT_ID }}
-          command: pages publish --project-name=example
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: pages deploy YOUR_DIST_FOLDER --project-name=example
 ```
 
 ### Deploying on a schedule
@@ -182,18 +175,18 @@ If you would like to deploy your Workers application on a recurring basis – fo
 ```yaml
 on:
   schedule:
-    - cron: '0 * * * *'
+    - cron: "0 * * * *"
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
-      - name: Publish app
-        uses: cloudflare/wrangler-action@2.0.0
+      - 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.
@@ -207,24 +200,109 @@ on:
   workflow_dispatch:
     inputs:
       environment:
-        description: 'Choose an environment to deploy to: <dev|staging|prod>'
+        description: "Choose an environment to deploy to: <dev|staging|prod>"
         required: true
-        default: 'dev'
+        default: "dev"
 jobs:
   deploy:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
-      - name: Publish app
-        uses: cloudflare/wrangler-action@2.0.0
+      - uses: actions/checkout@v4
+      - name: Deploy app
+        uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
-          command: publish --env ${{ github.event.inputs.environment }}
+          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!"
@@ -243,10 +321,10 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@v3
-      - name: Publish app
-        uses: cloudflare/wrangler-action@2.0.0
+      - 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

@@ -2,41 +2,52 @@ name: "Deploy to Cloudflare Workers with Wrangler"
 branding:
   icon: "upload-cloud"
   color: "orange"
-description: "Deploy your Cloudflare Workers and Pages projects from GitHub using Wrangler"
+description: "Deploy your Cloudflare projects from GitHub using Wrangler"
 runs:
-  using: "docker"
-  image: "Dockerfile"
+  # Possible values: https://github.com/actions/runner/blob/main/src/Runner.Common/Util/NodeUtil.cs#L9
+  using: "node20"
+  main: "dist/index.mjs"
 inputs:
-  apiKey:
-    description: "(Legacy) Your Cloudflare API Key"
-    required: false
-  email:
-    description: "(Legacy) Your Cloudflare Email"
-    required: false
   apiToken:
     description: "Your Cloudflare API Token"
     required: false
   accountId:
     description: "Your Cloudflare Account ID"
     required: false
-
+  quiet:
+    description: "Supresses output from Wrangler commands, defaults to `false`"
+    required: false
+    default: "false"
   environment:
-    description: "The environment you'd like to publish your Workers project to - must be defined in wrangler.toml"
+    description: "The environment you'd like to deploy your Workers project to - must be defined in wrangler.toml"
   workingDirectory:
     description: "The relative path which Wrangler commands should be run from"
     required: false
   wranglerVersion:
-    description: "The version of Wrangler you'd like to use to publish your Workers project"
+    description: "The version of Wrangler you'd like to use to deploy your Workers project"
     required: false
   secrets:
-    description: "A new line deliminated string of environment variable names that should be configured as Worker secrets"
+    description: "A string of environment variable names, separated by newlines. These will be bound to your Worker as Secrets and must match the names of environment variables declared in `env` of this workflow."
     required: false
   preCommands:
-    description: "Commands to execute before publishing the Workers project"
+    description: "Commands to execute before deploying the Workers project"
     required: false
   postCommands:
-    description: "Commands to execute after publishing the Workers project"
+    description: "Commands to execute after deploying the Workers project"
     required: false
   command:
-    description: "The Wrangler command you wish to run. For example: \"publish\" - this will publish your Worker"
-    required: false
+    description: 'The Wrangler command (along with any arguments) you wish to run. Multiple Wrangler commands can be run by separating each command with a newline. Defaults to `"deploy"`.'
+    required: false
+  vars:
+    description: "A string of environment variable names, separated by newlines. These will be bound to your Worker using the values of matching environment variables declared in `env` of this workflow."
+    required: false
+  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"

entrypoint.sh

@@ -1,161 +0,0 @@
-#!/bin/bash
-
-set -e
-
-export HOME="/github/workspace"
-export WRANGLER_HOME="/github/workspace"
-
-mkdir -p "$HOME/.wrangler"
-chmod -R 770 "$HOME/.wrangler"
-
-export API_CREDENTIALS=""
-
-# Used to execute any specified pre and post commands
-execute_commands() {
-  echo "$ Running: $1"
-  COMMANDS=$1
-  while IFS= read -r COMMAND; do
-    CHUNKS=()
-
-    for CHUNK in $COMMAND; do
-      CHUNKS+=("$CHUNK")
-    done
-
-    eval "${CHUNKS[@]}"
-
-    CHUNKS=()
-  done <<< "$COMMANDS"
-}
-
-secret_not_found() {
-  echo "::error::Specified secret \"$1\" not found in environment variables."
-  exit 1
-}
-
-WRANGLER_VERSION=2
-
-# If no Wrangler version is specified install v2.
-if [ -z "$INPUT_WRANGLERVERSION" ]; then
-  npm i -g wrangler
-
-# If Wrangler version starts with 1 then install wrangler v1
-elif [[ "$INPUT_WRANGLERVERSION" == 1* ]]; then
-  npm i -g "@cloudflare/wrangler@$INPUT_WRANGLERVERSION"
-  WRANGLER_VERSION=1
-
-# Else install Wrangler 2
-else
-  npm i -g "wrangler@$INPUT_WRANGLERVERSION"
-  WRANGLER_VERSION=2
-fi
-
-# If an API token is detected as input
-if [ -n "$INPUT_APITOKEN" ]; then
-
-  # Wrangler v1 uses CF_API_TOKEN but v2 uses CLOUDFLARE_API_TOKEN
-  if [ $WRANGLER_VERSION == 1 ]; then
-    export CF_API_TOKEN="$INPUT_APITOKEN"
-  else
-    export CLOUDFLARE_API_TOKEN="$INPUT_APITOKEN"
-  fi
-
-  export API_CREDENTIALS="API Token"
-fi
-
-# If an API key and email are detected as input
-if [ -n "$INPUT_APIKEY" ] && [ -n "$INPUT_EMAIL" ]; then
-
-  # Wrangler v1 uses CF_ but v2 uses CLOUDFLARE_
-  if [ $WRANGLER_VERSION == 1 ]; then
-    export CF_EMAIL="$INPUT_EMAIL"
-    export CF_API_KEY="$INPUT_APIKEY"
-  else
-    echo "::error::Wrangler v2 does not support using the API Key. You should instead use an API token."
-    exit 1
-  fi
-  
-  export API_CREDENTIALS="Email and API Key"
-fi
-
-if [ -n "$INPUT_ACCOUNTID" ]; then
-
-  if [ $WRANGLER_VERSION == 1 ]; then
-    export CF_ACCOUNT_ID="$INPUT_ACCOUNTID"
-  else
-    export CLOUDFLARE_ACCOUNT_ID="$INPUT_ACCOUNTID"
-  fi
-  
-fi
-
-if [ -n "$INPUT_APIKEY" ] && [ -z "$INPUT_EMAIL" ]
-then
-  echo "Provided an API key without an email for authentication. Please pass in 'apiKey' and 'email' to the action."
-fi
-
-if [ -z "$INPUT_APIKEY" ] && [ -n "$INPUT_EMAIL" ]
-then
-  echo "Provided an email without an API key for authentication. Please pass in 'apiKey' and 'email' to the action."
-  exit 1
-fi
-
-if [ -z "$API_CREDENTIALS" ]
-then
-  >&2 echo "Unable to find authentication details. Please pass in an 'apiToken' as an input to the action, or a legacy 'apiKey' and 'email'."
-  exit 1
-else
-  echo "Using $API_CREDENTIALS authentication"
-fi
-
-# If a working directory is detected as input
-if [ -n "$INPUT_WORKINGDIRECTORY" ]
-then
-  cd "$INPUT_WORKINGDIRECTORY"
-fi
-
-# If precommands is detected as input
-if [ -n "$INPUT_PRECOMMANDS" ]
-then
-  execute_commands "$INPUT_PRECOMMANDS"
-fi
-
-# If we have secrets, set them
-for SECRET in $INPUT_SECRETS; do
-  VALUE=$(printenv "$SECRET") || secret_not_found "$SECRET"
-
-  if [ -z "$INPUT_ENVIRONMENT" ]; then
-    echo "$VALUE" | wrangler secret put "$SECRET"
-  else
-    echo "$VALUE" | wrangler secret put "$SECRET" --env "$INPUT_ENVIRONMENT"
-  fi
-done
-
-# If there's no input command then default to publish otherwise run it
-if [ -z "$INPUT_COMMAND" ]; then
-  echo "::notice:: No command was provided, defaulting to 'publish'"
-
- if [ -z "$INPUT_ENVIRONMENT" ]; then
-    wrangler publish
-  else
-    wrangler publish --env "$INPUT_ENVIRONMENT"
-  fi
-
-else
-  if [ -n "$INPUT_ENVIRONMENT" ]; then
-    echo "::notice::Since you have specified an environment you need to make sure to pass in '--env $INPUT_ENVIRONMENT' to your command."
-  fi
-
-  execute_commands "wrangler $INPUT_COMMAND"
-fi
-
-# If postcommands is detected as input
-if [ -n "$INPUT_POSTCOMMANDS" ]
-then
-  execute_commands "$INPUT_POSTCOMMANDS"
-fi
-
-# If a working directory is detected as input, revert to the
-# original directory before continuing with the workflow
-if [ -n "$INPUT_WORKINGDIRECTORY" ]
-then
-  cd $HOME
-fi

package.json

@@ -0,0 +1,46 @@
+{
+	"name": "wrangler-action",
+	"version": "3.6.0",
+	"description": "GitHub Action to use [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/).",
+	"author": "wrangler@cloudflare.com",
+	"license": "MIT OR Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/cloudflare/wrangler-action/issues"
+	},
+	"homepage": "https://github.com/cloudflare/wrangler-action#readme",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/cloudflare/wrangler-action.git"
+	},
+	"keywords": [
+		"script",
+		"cli",
+		"serverless",
+		"cloudflare",
+		"cloudflare-workers",
+		"typescript"
+	],
+	"type": "module",
+	"main": "dist/index.mjs",
+	"scripts": {
+		"build": "npx ncc build ./src/index.ts && mv ./dist/index.js ./dist/index.mjs",
+		"test": "vitest",
+		"format": "prettier --write .",
+		"check": "prettier --check ."
+	},
+	"dependencies": {
+		"@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.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/exec.ts

@@ -0,0 +1,54 @@
+import {
+	exec as _childProcessExec,
+	type ExecException,
+} from "node:child_process";
+import { EOL } from "node:os";
+import { promisify } from "node:util";
+
+export { exec } from "@actions/exec";
+
+const childProcessExec = promisify(_childProcessExec);
+
+type ExecAsyncException = ExecException & {
+	stderr: string;
+	stdout: string;
+};
+
+function isExecAsyncException(err: unknown): err is ExecAsyncException {
+	return err instanceof Error && "code" in err && "stderr" in err;
+}
+
+export async function execShell(
+	command: string,
+	{
+		silent = false,
+		...options
+	}: Parameters<typeof childProcessExec>[1] & { silent?: boolean } = {},
+) {
+	if (!silent) {
+		process.stdout.write("[command]" + command + EOL);
+	}
+
+	try {
+		const promise = childProcessExec(command, {
+			...options,
+		});
+
+		const { child } = promise;
+
+		if (!silent) {
+			child.stdout?.on("data", (data: Buffer) => process.stdout.write(data));
+			child.stderr?.on("data", (data: Buffer) => process.stderr.write(data));
+		}
+
+		await promise;
+		return child.exitCode;
+	} catch (err: any) {
+		if (isExecAsyncException(err)) {
+			process.stderr.write(err.stderr);
+			throw new Error(`Process failed with exit code ${err.code}`);
+		}
+
+		throw err;
+	}
+}

src/index.ts

@@ -0,0 +1,364 @@
+import {
+	getBooleanInput,
+	getInput,
+	getMultilineInput,
+	endGroup as originalEndGroup,
+	error as originalError,
+	info as originalInfo,
+	debug,
+	startGroup as originalStartGroup,
+	setFailed,
+	setOutput,
+} from "@actions/core";
+import { getExecOutput } from "@actions/exec";
+import semverEq from "semver/functions/eq";
+import { exec, execShell } from "./exec";
+import { checkWorkingDirectory, semverCompare } from "./utils";
+import { getPackageManager } from "./packageManagers";
+
+const DEFAULT_WRANGLER_VERSION = "3.13.2";
+
+/**
+ * A configuration object that contains all the inputs & immutable state for the action.
+ */
+const config = {
+	WRANGLER_VERSION: getInput("wranglerVersion") || DEFAULT_WRANGLER_VERSION,
+	didUserProvideWranglerVersion: Boolean(getInput("wranglerVersion")),
+	secrets: getMultilineInput("secrets"),
+	workingDirectory: checkWorkingDirectory(getInput("workingDirectory")),
+	CLOUDFLARE_API_TOKEN: getInput("apiToken"),
+	CLOUDFLARE_ACCOUNT_ID: getInput("accountId"),
+	ENVIRONMENT: getInput("environment"),
+	VARS: getMultilineInput("vars"),
+	COMMANDS: getMultilineInput("command"),
+	QUIET_MODE: getBooleanInput("quiet"),
+	PACKAGE_MANAGER: getInput("packageManager"),
+} as const;
+
+const packageManager = getPackageManager(config.PACKAGE_MANAGER, {
+	workingDirectory: config.workingDirectory,
+});
+
+function info(message: string, bypass?: boolean): void {
+	if (!config.QUIET_MODE || bypass) {
+		originalInfo(message);
+	}
+}
+
+function error(message: string, bypass?: boolean): void {
+	if (!config.QUIET_MODE || bypass) {
+		originalError(message);
+	}
+}
+
+function startGroup(name: string): void {
+	if (!config.QUIET_MODE) {
+		originalStartGroup(name);
+	}
+}
+
+function endGroup(): void {
+	if (!config.QUIET_MODE) {
+		originalEndGroup();
+	}
+}
+
+async function main() {
+	try {
+		authenticationSetup();
+		await installWrangler();
+		await execCommands(getMultilineInput("preCommands"), "pre");
+		await uploadSecrets();
+		await wranglerCommands();
+		await execCommands(getMultilineInput("postCommands"), "post");
+		info("🏁 Wrangler Action completed", true);
+	} catch (err: unknown) {
+		err instanceof Error && error(err.message);
+		setFailed("🚨 Action failed");
+	}
+}
+
+async function installWrangler() {
+	if (config["WRANGLER_VERSION"].startsWith("1")) {
+		throw new Error(
+			`Wrangler v1 is no longer supported by this action. Please use major version 2 or greater`,
+		);
+	}
+
+	startGroup("🔍 Checking for existing Wrangler installation");
+	let installedVersion = "";
+	let installedVersionSatisfiesRequirement = false;
+	try {
+		const { stdout } = await getExecOutput(
+			packageManager.exec,
+			["wrangler", "--version"],
+			{
+				cwd: config["workingDirectory"],
+				silent: config.QUIET_MODE,
+			},
+		);
+		// There are two possible outputs from `wrangler --version`:
+		// ` ⛅️ wrangler 3.48.0 (update available 3.53.1)`
+		// and
+		// `3.48.0`
+		const versionMatch =
+			stdout.match(/wrangler (\d+\.\d+\.\d+)/) ??
+			stdout.match(/^(\d+\.\d+\.\d+)/);
+		if (versionMatch) {
+			installedVersion = versionMatch[1];
+		}
+		if (config.didUserProvideWranglerVersion) {
+			installedVersionSatisfiesRequirement = semverEq(
+				installedVersion,
+				config["WRANGLER_VERSION"],
+			);
+		}
+		if (!config.didUserProvideWranglerVersion && installedVersion) {
+			info(
+				`✅ No wrangler version specified, using pre-installed wrangler version ${installedVersion}`,
+				true,
+			);
+			endGroup();
+			return;
+		}
+		if (
+			config.didUserProvideWranglerVersion &&
+			installedVersionSatisfiesRequirement
+		) {
+			info(`✅ Using Wrangler ${installedVersion}`, true);
+			endGroup();
+			return;
+		}
+		info(
+			"⚠️ Wrangler not found or version is incompatible. Installing...",
+			true,
+		);
+	} catch (error) {
+		debug(`Error checking Wrangler version: ${error}`);
+		info(
+			"⚠️ Wrangler not found or version is incompatible. Installing...",
+			true,
+		);
+	} finally {
+		endGroup();
+	}
+
+	startGroup("📥 Installing Wrangler");
+	try {
+		await exec(
+			packageManager.install,
+			[`wrangler@${config["WRANGLER_VERSION"]}`],
+			{
+				cwd: config["workingDirectory"],
+				silent: config["QUIET_MODE"],
+			},
+		);
+
+		info(`✅ Wrangler installed`, true);
+	} finally {
+		endGroup();
+	}
+}
+
+function authenticationSetup() {
+	process.env.CLOUDFLARE_API_TOKEN = config["CLOUDFLARE_API_TOKEN"];
+	process.env.CLOUDFLARE_ACCOUNT_ID = config["CLOUDFLARE_ACCOUNT_ID"];
+}
+
+async function execCommands(commands: string[], cmdType: string) {
+	if (!commands.length) {
+		return;
+	}
+
+	startGroup(`🚀 Running ${cmdType}Commands`);
+	try {
+		for (const command of commands) {
+			const cmd = command.startsWith("wrangler")
+				? `${packageManager.exec} ${command}`
+				: command;
+
+			await execShell(cmd, {
+				cwd: config["workingDirectory"],
+				silent: config["QUIET_MODE"],
+			});
+		}
+	} finally {
+		endGroup();
+	}
+}
+
+function getSecret(secret: string) {
+	if (!secret) {
+		throw new Error("Secret name cannot be blank.");
+	}
+
+	const value = process.env[secret];
+	if (!value) {
+		throw new Error(`Value for secret ${secret} not found in environment.`);
+	}
+
+	return value;
+}
+
+function getEnvVar(envVar: string) {
+	if (!envVar) {
+		throw new Error("Var name cannot be blank.");
+	}
+
+	const value = process.env[envVar];
+	if (!value) {
+		throw new Error(`Value for var ${envVar} not found in environment.`);
+	}
+
+	return value;
+}
+
+async function legacyUploadSecrets(
+	secrets: string[],
+	environment?: string,
+	workingDirectory?: string,
+) {
+	for (const secret of secrets) {
+		const args = ["wrangler", "secret", "put", secret];
+		if (environment) {
+			args.push("--env", environment);
+		}
+		await exec(packageManager.exec, args, {
+			cwd: workingDirectory,
+			silent: config["QUIET_MODE"],
+			input: Buffer.from(getSecret(secret)),
+		});
+	}
+}
+
+async function uploadSecrets() {
+	const secrets: string[] = config["secrets"];
+	const environment = config["ENVIRONMENT"];
+	const workingDirectory = config["workingDirectory"];
+
+	if (!secrets.length) {
+		return;
+	}
+
+	startGroup("🔑 Uploading secrets...");
+
+	try {
+		if (semverCompare(config["WRANGLER_VERSION"], "3.4.0")) {
+			return legacyUploadSecrets(secrets, environment, workingDirectory);
+		}
+
+		const args = ["wrangler", "secret:bulk"];
+
+		if (environment) {
+			args.push("--env", environment);
+		}
+
+		await exec(packageManager.exec, args, {
+			cwd: workingDirectory,
+			silent: config["QUIET_MODE"],
+			input: Buffer.from(
+				JSON.stringify(
+					Object.fromEntries(
+						secrets.map((secret) => [secret, getSecret(secret)]),
+					),
+				),
+			),
+		});
+	} catch (err: unknown) {
+		if (err instanceof Error) {
+			error(err.message);
+			err.stack && debug(err.stack);
+		}
+		throw new Error(`Failed to upload secrets.`);
+	} finally {
+		endGroup();
+	}
+}
+
+async function wranglerCommands() {
+	startGroup("🚀 Running Wrangler Commands");
+	try {
+		const commands = config["COMMANDS"];
+		const environment = config["ENVIRONMENT"];
+
+		if (!commands.length) {
+			const wranglerVersion = config["WRANGLER_VERSION"];
+			const deployCommand = semverCompare("2.20.0", wranglerVersion)
+				? "deploy"
+				: "publish";
+			commands.push(deployCommand);
+		}
+
+		for (let command of commands) {
+			const args = [];
+
+			if (environment && !command.includes("--env")) {
+				args.push("--env", environment);
+			}
+
+			if (
+				config["VARS"].length &&
+				(command.startsWith("deploy") || command.startsWith("publish")) &&
+				!command.includes("--var")
+			) {
+				args.push("--var");
+				for (const v of config["VARS"]) {
+					args.push(`${v}:${getEnvVar(v)}`);
+				}
+			}
+
+			// 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();
+	}
+}
+
+main();
+
+export {
+	authenticationSetup,
+	execCommands,
+	installWrangler,
+	uploadSecrets,
+	wranglerCommands,
+};

src/packageManagers.test.ts

@@ -0,0 +1,94 @@
+import { describe, expect, test } from "vitest";
+import { getPackageManager } from "./packageManagers";
+
+describe("getPackageManager", () => {
+	test("should use provided value instead of inferring from lockfile", () => {
+		expect(getPackageManager("npm", { workingDirectory: "test/npm" }))
+			.toMatchInlineSnapshot(`
+				{
+				  "exec": "npx",
+				  "install": "npm i",
+				}
+			`);
+
+		expect(getPackageManager("yarn", { workingDirectory: "test/npm" }))
+			.toMatchInlineSnapshot(`
+			{
+			  "exec": "yarn",
+			  "install": "yarn add",
+			}
+		`);
+
+		expect(getPackageManager("pnpm", { workingDirectory: "test/npm" }))
+			.toMatchInlineSnapshot(`
+				{
+				  "exec": "pnpm exec",
+				  "install": "pnpm add",
+				}
+			`);
+
+		expect(getPackageManager("bun", { workingDirectory: "test/bun" }))
+			.toMatchInlineSnapshot(`
+				{
+				  "exec": "bunx",
+				  "install": "bun i",
+				}
+			`);
+	});
+
+	test("should use npm if no value provided and package-lock.json exists", () => {
+		expect(getPackageManager("", { workingDirectory: "test/npm" }))
+			.toMatchInlineSnapshot(`
+			{
+			  "exec": "npx",
+			  "install": "npm i",
+			}
+		`);
+	});
+
+	test("should use yarn if no value provided and yarn.lock exists", () => {
+		expect(getPackageManager("", { workingDirectory: "test/yarn" }))
+			.toMatchInlineSnapshot(`
+			{
+			  "exec": "yarn",
+			  "install": "yarn add",
+			}
+		`);
+	});
+
+	test("should use pnpm if no value provided and pnpm-lock.yaml exists", () => {
+		expect(getPackageManager("", { workingDirectory: "test/pnpm" }))
+			.toMatchInlineSnapshot(`
+			{
+			  "exec": "pnpm exec",
+			  "install": "pnpm add",
+			}
+		`);
+	});
+
+	test("should use bun if no value provided and bun.lockb exists", () => {
+		expect(getPackageManager("", { workingDirectory: "test/bun" }))
+			.toMatchInlineSnapshot(`
+			{
+			  "exec": "bunx",
+			  "install": "bun i",
+			}
+			`);
+	});
+
+	test("should use npm if no value provided and no lockfile is present", () => {
+		expect(getPackageManager("", { workingDirectory: "test/empty" }))
+			.toMatchInlineSnapshot(`
+			{
+			  "exec": "npx",
+			  "install": "npm i",
+			}
+		`);
+	});
+
+	test("should throw if an invalid value is provided", () => {
+		expect(() =>
+			getPackageManager("cargo", { workingDirectory: "test/npm" }),
+		).toThrowError();
+	});
+});

src/packageManagers.ts

@@ -0,0 +1,68 @@
+import { existsSync } from "node:fs";
+import * as path from "node:path";
+
+interface PackageManager {
+	install: string;
+	exec: string;
+}
+
+const PACKAGE_MANAGERS = {
+	npm: {
+		install: "npm i",
+		exec: "npx",
+	},
+	yarn: {
+		install: "yarn add",
+		exec: "yarn",
+	},
+	pnpm: {
+		install: "pnpm add",
+		exec: "pnpm exec",
+	},
+	bun: {
+		install: "bun i",
+		exec: "bunx",
+	},
+} as const satisfies Readonly<Record<string, PackageManager>>;
+
+type PackageManagerValue = keyof typeof PACKAGE_MANAGERS;
+
+function detectPackageManager(
+	workingDirectory = ".",
+): PackageManagerValue | null {
+	if (existsSync(path.join(workingDirectory, "package-lock.json"))) {
+		return "npm";
+	}
+	if (existsSync(path.join(workingDirectory, "yarn.lock"))) {
+		return "yarn";
+	}
+	if (existsSync(path.join(workingDirectory, "pnpm-lock.yaml"))) {
+		return "pnpm";
+	}
+	if (existsSync(path.join(workingDirectory, "bun.lockb"))) {
+		return "bun";
+	}
+	return null;
+}
+
+function assertValidPackageManagerValue(
+	name: string,
+): asserts name is PackageManagerValue | "" {
+	if (name && !Object.keys(PACKAGE_MANAGERS).includes(name)) {
+		throw new TypeError(
+			`invalid value provided for "packageManager": ${name}
+	Value must be one of: [${Object.keys(PACKAGE_MANAGERS).join(", ")}]`,
+		);
+	}
+}
+
+export function getPackageManager(
+	name: string,
+	{ workingDirectory = "." }: { workingDirectory?: string } = {},
+) {
+	assertValidPackageManagerValue(name);
+
+	return PACKAGE_MANAGERS[
+		name || detectPackageManager(workingDirectory) || "npm"
+	];
+}

src/utils.test.ts

@@ -0,0 +1,55 @@
+import path from "node:path";
+import { describe, expect, test } from "vitest";
+import { checkWorkingDirectory, semverCompare } from "./utils";
+
+describe("semverCompare", () => {
+	test("should return false if the second argument is equal to the first argument", () => {
+		const isVersion1LessThanVersion2 = semverCompare("1.2.3", "1.2.3");
+
+		expect(isVersion1LessThanVersion2).toBe(false);
+	});
+
+	test("should return true if the first argument is less than the second argument", () => {
+		const isVersion1LessThanVersion2 = semverCompare("1.2.2", "1.2.3");
+
+		expect(isVersion1LessThanVersion2).toBe(true);
+	});
+});
+
+describe("checkWorkingDirectory", () => {
+	test("should return the normalized path if the directory exists", () => {
+		const normalizedPath = checkWorkingDirectory(".");
+		expect(normalizedPath).toBe(path.normalize("."));
+	});
+
+	test("should fail if the directory does not exist", () => {
+		expect(() =>
+			checkWorkingDirectory("/does/not/exist"),
+		).toThrowErrorMatchingInlineSnapshot(
+			`[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

@@ -0,0 +1,21 @@
+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.
+ */
+export function semverCompare(version1: string, version2: string) {
+	if (version2 === "latest") return true;
+
+	return semverGt(version2, version1);
+}
+
+export function checkWorkingDirectory(workingDirectory = ".") {
+	const normalizedPath = path.normalize(workingDirectory);
+	if (existsSync(normalizedPath)) {
+		return normalizedPath;
+	} else {
+		throw new Error(`Directory ${workingDirectory} does not exist.`);
+	}
+}

test/.gitignore

@@ -1 +0,0 @@
-dist

test/build-quiet/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/build-quiet/package-lock.json

@@ -0,0 +1,10 @@
+{
+	"name": "wrangler-action-test",
+	"lockfileVersion": 3,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "wrangler-action-test"
+		}
+	}
+}

test/build-quiet/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-test",
+	"license": "MIT",
+	"private": true
+}

test/build-quiet/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test-build-quiet"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/bun/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/bun/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-bun-test",
+	"license": "MIT",
+	"private": true
+}

test/bun/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/environment/index.ts

@@ -0,0 +1,20 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret") {
+			const { SECRET1 = "", SECRET2 = "" } = env;
+			return new Response(`${SECRET1} ${SECRET2}`);
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/environment/package-lock.json

@@ -0,0 +1,10 @@
+{
+	"name": "wrangler-action-environment-test",
+	"lockfileVersion": 3,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "wrangler-action-environment-test"
+		}
+	}
+}

test/environment/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-environment-test",
+	"license": "MIT",
+	"private": true
+}

test/environment/wrangler.toml

@@ -0,0 +1,9 @@
+name = "wrangler-action-environment-test"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true
+
+[env.dev]
+name = "wrangler-action-dev-environment-test"
+[env.dev.vars]
+DEV_VAR = "example_production_token"

test/npm/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/npm/package-lock.json

@@ -0,0 +1,10 @@
+{
+	"name": "wrangler-action-npm-test",
+	"lockfileVersion": 3,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "wrangler-action-npm-test"
+		}
+	}
+}

test/npm/package.json

@@ -0,0 +1,3 @@
+{
+	"name": "wrangler-action-npm-test"
+}

test/npm/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/only-build/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/only-build/package-lock.json

@@ -0,0 +1,10 @@
+{
+	"name": "wrangler-action-test",
+	"lockfileVersion": 3,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "wrangler-action-test"
+		}
+	}
+}

test/only-build/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-test",
+	"license": "MIT",
+	"private": true
+}

test/only-build/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test-only-build"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/pnpm/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/pnpm/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-pnpm-test",
+	"license": "MIT",
+	"private": true
+}

test/pnpm/pnpm-lock.yaml

@@ -0,0 +1,5 @@
+lockfileVersion: '6.0'
+
+settings:
+  autoInstallPeers: true
+  excludeLinksFromLockfile: false

test/pnpm/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/pre-installed-wrangler/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/pre-installed-wrangler/mock_packages/wrangler/index.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+"use strict";
+
+const args = Array.from(process.argv);
+const command = args.pop();
+switch (command) {
+	case "--version":
+		console.log(`
+⛅️ wrangler 1.1.1 (update available 1.2.3)
+------------------------------------------`);
+		process.exit(0);
+	case "action-test":
+		console.log("Test successful.");
+		process.exit(0);
+	default:
+		console.error("Invalid command");
+		process.exit(1);
+}

test/pre-installed-wrangler/mock_packages/wrangler/package.json

@@ -0,0 +1,7 @@
+{
+	"private": true,
+	"name": "wrangler",
+	"version": "1.1.1",
+	"main": "index.js",
+	"bin": "index.js"
+}

test/pre-installed-wrangler/package-lock.json

@@ -0,0 +1,30 @@
+{
+	"name": "wrangler-action-pre-installed-wrangler-test",
+	"lockfileVersion": 2,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "wrangler-action-pre-installed-wrangler-test",
+			"license": "MIT",
+			"devDependencies": {
+				"wrangler": "file:mock_packages/wrangler"
+			}
+		},
+		"mock_packages/wrangler": {
+			"version": "1.1.1",
+			"dev": true,
+			"bin": {
+				"wrangler": "index.js"
+			}
+		},
+		"node_modules/wrangler": {
+			"resolved": "mock_packages/wrangler",
+			"link": true
+		}
+	},
+	"dependencies": {
+		"wrangler": {
+			"version": "file:mock_packages/wrangler"
+		}
+	}
+}

test/pre-installed-wrangler/package.json

@@ -0,0 +1,8 @@
+{
+	"name": "wrangler-action-pre-installed-wrangler-test",
+	"license": "MIT",
+	"private": true,
+	"devDependencies": {
+		"wrangler": "file:mock_packages/wrangler"
+	}
+}

test/public/index.html

@@ -1,6 +0,0 @@
-<h1>My Static Site Test</h1>
-<p>This is the content of my site</p>
-
-<footer>
-  And this is my footer
-</footer>

test/secrets-default/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/secrets-default/package-lock.json

@@ -0,0 +1,10 @@
+{
+	"name": "wrangler-action-test",
+	"lockfileVersion": 3,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "wrangler-action-test"
+		}
+	}
+}

test/secrets-default/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-test",
+	"license": "MIT",
+	"private": true
+}

test/secrets-default/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test-secrets-default"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/secrets-v2/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/secrets-v2/package-lock.json

@@ -0,0 +1,10 @@
+{
+	"name": "wrangler-action-test",
+	"lockfileVersion": 3,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "wrangler-action-test"
+		}
+	}
+}

test/secrets-v2/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-test",
+	"license": "MIT",
+	"private": true
+}

test/secrets-v2/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test-secrets-v2"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/specify-package-manager/index.ts

@@ -0,0 +1 @@
+export default {};

test/specify-package-manager/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-detect-package-manager-test",
+	"license": "MIT",
+	"private": true
+}

test/specify-package-manager/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test-specify-package-manager"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/unspecified-package-manager/index.ts

@@ -0,0 +1 @@
+export default {};

test/unspecified-package-manager/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-detect-package-manager-test",
+	"license": "MIT",
+	"private": true
+}

test/unspecified-package-manager/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test-unspecified-package-manager"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/workers-site/index.js

@@ -1,88 +0,0 @@
-import { getAssetFromKV, mapRequestToAsset } from '@cloudflare/kv-asset-handler'
-
-/**
- * The DEBUG flag will do two things that help during development:
- * 1. we will skip caching on the edge, which makes it easier to
- *    debug.
- * 2. we will return an error message on exception in your response rather
- *    than the default 404.html page.
- */
-const DEBUG = false
-
-addEventListener('fetch', event => {
-  try {
-    event.respondWith(handleEvent(event))
-  } catch (e) {
-    if (DEBUG) {
-      return event.respondWith(
-        new Response(e.message || e.toString(), {
-          status: 500,
-        }),
-      )
-    }
-    event.respondWith(new Response('Internal Error', { status: 500 }))
-  }
-})
-
-async function handleEvent(event) {
-  const url = new URL(event.request.url)
-  let options = {}
-
-  /**
-   * You can add custom logic to how we fetch your assets
-   * by configuring the function `mapRequestToAsset`
-   */
-  // options.mapRequestToAsset = handlePrefix(/^\/docs/)
-
-  // Path to test secrets passed through Wrangler Action.  Create SECRET1 and SECRET2 secrets
-  // in the Action repo to something innocuous like "Hello" and "World!".
-  if (url.pathname === "/secret") {
-    let sec1 = (typeof SECRET1 !== 'undefined') ? SECRET1 : ""
-    let sec2 = (typeof SECRET2 !== 'undefined') ? SECRET2 : ""
-    return new Response(`${sec1} ${sec2}`)
-  }
-  
-  try {
-    if (DEBUG) {
-      // customize caching
-      options.cacheControl = {
-        bypassCache: true,
-      }
-    }
-    return await getAssetFromKV(event, options)
-  } catch (e) {
-    // if an error is thrown try to serve the asset at 404.html
-    if (!DEBUG) {
-      try {
-        let notFoundResponse = await getAssetFromKV(event, {
-          mapRequestToAsset: req => new Request(`${new URL(req.url).origin}/404.html`, req),
-        })
-
-        return new Response(notFoundResponse.body, { ...notFoundResponse, status: 404 })
-      } catch (e) {}
-    }
-
-    return new Response(e.message || e.toString(), { status: 500 })
-  }
-}
-
-/**
- * Here's one example of how to modify a request to
- * remove a specific prefix, in this case `/docs` from
- * the url. This can be useful if you are deploying to a
- * route on a zone, or if you only want your static content
- * to exist at a specific path.
- */
-function handlePrefix(prefix) {
-  return request => {
-    // compute the default (e.g. / -> index.html)
-    let defaultAssetKey = mapRequestToAsset(request)
-    let url = new URL(defaultAssetKey.url)
-
-    // strip the prefix from the path for lookup
-    url.pathname = url.pathname.replace(prefix, '/')
-
-    // inherit all other props from the default request
-    return new Request(url.toString(), defaultAssetKey)
-  }
-}

test/workers-site/package-lock.json

@@ -1,21 +0,0 @@
-{
-  "name": "worker",
-  "version": "1.0.0",
-  "lockfileVersion": 1,
-  "requires": true,
-  "dependencies": {
-    "@cloudflare/kv-asset-handler": {
-      "version": "0.0.5",
-      "resolved": "https://registry.npmjs.org/@cloudflare/kv-asset-handler/-/kv-asset-handler-0.0.5.tgz",
-      "integrity": "sha512-7yLMAUZD1XQNKzmktYCcUUPB+wXmQENv1MMi8QEMs0rzL01e0XEyCUUDauRXHzxi7dBbSUGA5RS23h890ncKog==",
-      "requires": {
-        "mime": "^2.4.4"
-      }
-    },
-    "mime": {
-      "version": "2.4.4",
-      "resolved": "https://registry.npmjs.org/mime/-/mime-2.4.4.tgz",
-      "integrity": "sha512-LRxmNwziLPT828z+4YkNzloCFC2YM4wrB99k+AV5ZbEyfGNWfG8SO1FUXLmLDBSo89NrJZ4DIWeLjy1CHGhMGA=="
-    }
-  }
-}

test/workers-site/package.json

@@ -1,12 +0,0 @@
-{
-  "private": true,
-  "name": "worker",
-  "version": "1.0.0",
-  "description": "A template for kick starting a Cloudflare Workers project",
-  "main": "index.js",
-  "author": "Ashley Lewis <ashleymichal@gmail.com>",
-  "license": "MIT",
-  "dependencies": {
-    "@cloudflare/kv-asset-handler": "^0.0.5"
-  }
-}

test/wrangler.toml

@@ -1,11 +0,0 @@
-name = "static-test"
-type = "webpack"
-workers_dev = true
-account_id = "dc56444c4c955a1653106ccf997c1067"
-
-[env.production]
-name = "static-test-prod"
-
-[site]
-bucket = "./public"
-entry-point = "workers-site"

test/yarn/index.ts

@@ -0,0 +1,25 @@
+type Env = {
+	SECRET1?: string;
+	SECRET2?: string;
+};
+
+export default {
+	fetch(request: Request, env: Env) {
+		const url = new URL(request.url);
+
+		if (url.pathname === "/secret-health-check") {
+			const { SECRET1, SECRET2 } = env;
+
+			if (SECRET1 !== "SECRET_1_VALUE" || SECRET2 !== "SECRET_2_VALUE") {
+				throw new Error("SECRET1 or SECRET2 is not defined");
+			}
+
+			return new Response("OK");
+		}
+
+		return Response.json({
+			...request,
+			headers: Object.fromEntries(request.headers),
+		});
+	},
+};

test/yarn/package.json

@@ -0,0 +1,5 @@
+{
+	"name": "wrangler-action-yarn-test",
+	"license": "MIT",
+	"private": true
+}

test/yarn/wrangler.toml

@@ -0,0 +1,4 @@
+name = "wrangler-action-test"
+main = "./index.ts"
+compatibility_date = "2023-07-07"
+workers_dev = true

test/yarn/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+

tsconfig.json

@@ -0,0 +1,20 @@
+{
+	"files": ["./src/index.ts"],
+	"compilerOptions": {
+		"strict": true,
+		"composite": true,
+		"incremental": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"isolatedModules": true,
+		"target": "ESNext",
+		"module": "ESNext",
+		"moduleResolution": "Bundler",
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"lib": ["ESNext"],
+		"types": ["node", "@cloudflare/workers-types"]
+	},
+	"exclude": ["node_modules", "**/*.test.ts"],
+	"include": ["src"]
+}