2020-06-16 06:09:55 +02:00
name : "Deploy to Cloudflare Workers with Wrangler"
2019-10-15 17:14:20 +02:00
branding :
2020-06-16 06:09:55 +02:00
icon : "upload-cloud"
color : "orange"
2023-08-01 21:31:45 +02:00
description : "Deploy your Cloudflare projects from GitHub using Wrangler"
2019-10-07 21:41:21 +02:00
runs :
2023-09-04 20:54:36 +02:00
# Possible values: https://github.com/actions/runner/blob/main/src/Runner.Common/Util/NodeUtil.cs#L9
2023-09-04 20:50:59 +02:00
using : "node20"
2023-08-09 18:16:08 +02:00
main : "dist/index.mjs"
2019-10-11 21:25:47 +02:00
inputs :
2022-05-09 12:49:03 +02:00
apiToken :
description : "Your Cloudflare API Token"
required : false
accountId :
description : "Your Cloudflare Account ID"
required : false
2023-08-11 22:36:20 +02:00
quiet :
description : "Supresses output from Wrangler commands, defaults to `false`"
required : false
default : "false"
2019-10-14 22:24:54 +02:00
environment :
2023-08-07 21:57:12 +02:00
description : "The environment you'd like to deploy your Workers project to - must be defined in wrangler.toml"
2019-11-07 22:15:49 +01:00
workingDirectory :
description : "The relative path which Wrangler commands should be run from"
2022-05-09 12:49:03 +02:00
required : false
2019-11-22 17:27:40 +01:00
wranglerVersion :
2023-08-07 21:57:12 +02:00
description : "The version of Wrangler you'd like to use to deploy your Workers project"
2022-05-09 12:49:03 +02:00
required : false
2020-06-16 06:09:55 +02:00
secrets :
2023-08-01 21:31:45 +02:00
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."
2020-06-16 06:09:55 +02:00
required : false
2020-08-07 23:16:42 +02:00
preCommands :
2023-08-07 21:57:12 +02:00
description : "Commands to execute before deploying the Workers project"
2020-08-07 23:16:42 +02:00
required : false
postCommands :
2023-08-07 21:57:12 +02:00
description : "Commands to execute after deploying the Workers project"
2020-08-07 23:16:42 +02:00
required : false
2022-05-09 12:49:03 +02:00
command :
2023-08-01 21:31:45 +02:00
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
2023-09-01 23:34:18 +02:00
packageManager :
2023-10-11 01:00:32 +02:00
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`."
2023-09-13 01:27:33 +02:00
required : false
2023-12-01 19:04:51 +01:00
outputs :
2023-12-08 06:26:06 +01:00
command-output :
2023-12-08 06:30:51 +01:00
description : "The output of the Wrangler command (comes from stdout)"
command-stderr :
description : "The error output of the Wrangler command (comes from stderr)"
2023-12-08 06:48:10 +01:00
deployment-url :
2023-12-13 06:19:53 +01:00
description : "If the command was a Workers or Pages deployment, this will be the URL of the deployment"
2024-09-19 18:43:48 +02:00
deployment-alias-url :
description : "If the command was a Workers or Pages deployment, this can be the URL of the deployment alias (if it exists) - needs wrangler >= 3.78.0"