GitLab Pipelines
You can deploy Workers with GitLab CI/CD ↗. Here is how you can set up your GitHub Actions workflow.
When running Wrangler locally, authentication to the Cloudflare API happens via the wrangler login
command, which initiates an interactive authentication flow. Since CI/CD environments are non-interactive, Wrangler requires a Cloudflare API token and account ID to authenticate with the Cloudflare API.
To find your Cloudflare account ID, refer to Find account and zone IDs.
To create an API token to authenticate Wrangler in your CI job:
- Log in to the Cloudflare dashboard ↗.
- Select My Profile > API Tokens.
- Select Create Token > find Edit Cloudflare Workers > select Use Template.
- Customize your token name.
- Scope your token.
You will need to choose the account and zone resources that the generated API token will have access to. We recommend scoping these down as much as possible to limit the access of your token. For example, if you have access to three different Cloudflare accounts, you should restrict the generated API token to only the account on which you will be deploying a Worker.
The method for running Wrangler in your CI/CD environment will depend on the specific setup for your project (whether you use GitHub Actions/Jenkins/GitLab or something else entirely).
To set up your CI:
- Go to your CI platform and add the following as secrets:
CLOUDFLARE_ACCOUNT_ID
: Set to the Cloudflare account ID for the account on which you want to deploy your Worker.CLOUDFLARE_API_TOKEN
: Set to the Cloudflare API token you generated.
- Create a workflow that will be responsible for deploying the Worker. This workflow should run
wrangler deploy
. Review an example GitHub Actions ↗ workflow in the follow section.
Refer to GitLab's blog ↗ for an example pipeline. Under the script
key, replace npm run deploy
with npx wrangler deploy
.