This document outlines the security procedures and general policies for the "Deploy to Cloudflare Workers with Wrangler using Node" GitHub Action.
As of the latest update to this policy, we are providing support and security updates to the following version of the action:
Version | Supported |
---|---|
1.x.x | ✅ |
If you discover a vulnerability in the GitHub Action, please follow the guidelines provided by GitHub for privately reporting a security vulnerability. You can find these instructions at the following link: Privately reporting a security vulnerability.
If you discover a vulnerability in wrangler
itself, please report it directly to Cloudflare as per their instructions outlined here.
-
Authentication: The action uses GitHub's Secrets feature for configuring Wrangler. The secrets feature allows you to store sensitive information, such as your Cloudflare API token, securely in your repository. The action also supports using your global API key and email as an authentication method, although API tokens are preferred.
-
Log Safety: Your API token is encrypted by GitHub, and the action won't print it into logs, so it should be safe.
-
Worker Secrets: Worker secrets can be optionally passed as a new line delimited string of names in
secrets
. Each secret name must match an environment variable name specified in theenv
attribute. Creates or replaces the value for the Worker secret using thewrangler secret put
command. -
Additional Commands: If you need to run additional shell commands before or after your command, you can specify them as input to
preCommands
(beforepublish
) orpostCommands
(afterpublish
). These can include additionalwrangler
commands or any other commands available inside thewrangler-action
context. -
Event Triggers: 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.
To ensure the security of your project, it is recommended that you keep the action updated to the latest version. Regular updates ensure that you are protected from any known vulnerabilities and also gain access to any new features and improvements. You can also use the major version tag (e.g., @v1
) as the suffix to the command to ensure that you are using the latest release within that major version. Example:
- uses: demosjarco/wrangler-action-node@v1
For any security-related issues or inquiries not covered in this document, please refer to the general GitHub security practices and policies.
This policy will be updated as new security procedures are implemented or existing procedures are modified. Please check back regularly for any updates.