Cloudflare Docs
Visit Workers on GitHub
Set theme to dark (⇧+D)

Deploy button

​​ Background

Deploy buttons let you deploy projects to the Workers platform in under five minutes. The deploy buttons use a Worker to deploy to the platform using the Workers GitHub Action. You can also make your own deploy buttons for your projects to make sharing your work easier.

Try the deploy button below to deploy a GraphQL server:

Select Deploy with Workers to deploy a GraphQL server

Refer to for additional projects to deploy.

​​ Create a deploy button for your project

  1. Add a GitHub Actions workflow to your project.

Add a new file to .github/workflows, such as .github/workflows/deploy.yml, and create a GitHub workflow for deploying your project. It should include a set of on events, including at least repository_dispatch, but probably push and maybe schedule as well. Add a step for publishing your project using wrangler-action:

name: Build
runs-on: ubuntu-latest
timeout-minutes: 60
needs: test
- uses: actions/[email protected]
- name: Publish
uses: cloudflare/wrangler-[email protected]

  1. Add support for CF_API_TOKEN and CF_ACCOUNT_ID in your workflow:

    # Update "Publish" step from last code snippet
    - name: Publish
    uses: cloudflare/wrangler-[email protected]
    apiToken: ${{ secrets.CF_API_TOKEN }}
    CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}

  2. Add the Markdown code for your button to your project’s README, replacing the example url parameter with your repository URL.

    [![Deploy to Cloudflare Workers](](

Select Deploy with Workers to be redirected to the Deploy with Workers page