repository·main·Indexed 19 days ago
https://github.com/cloudflare/pages-actionA GitHub Action for creating Cloudflare Pages deployments using Direct Upload and Wrangler integration. This project is deprecated in favor of wrangler-action. Version 1.5.0 supports configuration for API tokens, account IDs, and project names, and provides deployment outputs such as the deployment ID, URL, alias, and environment.
You can find your Cloudflare Account ID using one of these methods:
https://dash.cloudflare.com/<ACCOUNT_ID>/pages.To deploy your project to Cloudflare Pages using this GitHub Action, follow these steps:
Cloudflare Pages — Edit permission.CLOUDFLARE_API_TOKEN..github/workflows/publish.yml file. You must provide apiToken, accountId, projectName, and directory (the build output folder).Example Workflow:
on: [push]
jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: read
deployments: write
name: Publish to Cloudflare Pages
steps:
- name: Checkout
uses: actions/checkout@v3
# Run your build step here (e.g., npm run build)
- name: Publish to Cloudflare Pages
uses: cloudflare/pages-action@v1
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: YOUR_ACCOUNT_ID
projectName: YOUR_PROJECT_NAME
directory: YOUR_BUILD_OUTPUT_DIRECTORY
# Optional: Enable GitHub Deployments tracking
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
# Optional: Specify the branch (determines production vs preview)
branch: main
# Optional: Specify directory for monorepos
workingDirectory: my-site
# Optional: Specify Wrangler version
wranglerVersion: '3'on: [push]
jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: read
deployments: write
name: Publish to Cloudflare Pages
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Publish to Cloudflare Pages
uses: cloudflare/pages-action@v1
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: YOUR_ACCOUNT_ID
projectName: YOUR_PROJECT_NAME
directory: YOUR_BUILD_OUTPUT_DIRECTORY
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
branch: main
workingDirectory: my-site
wranglerVersion: '3'To authorize the action, generate a custom token with the following steps:
pages-action is deprecated (latest version v1.5.0). It is highly recommended to migrate to wrangler-action, which provides a unified tool for managing both Workers and Pages.
Migration considerations:
wrangler-action differs from pages-action. Refer to the wrangler-action Pages deployment instructions.wrangler-action does not currently provide the same deployment outputs as pages-action. If your workflows rely on these, you may need temporary adjustments.wrangler-action but is planned for a future release.The Cloudflare Pages GitHub Action requires several inputs to perform a deployment. These inputs are passed via the GitHub Actions workflow YAML file.
apiToken: Your Cloudflare API Token.accountId: Your Cloudflare Account ID.projectName: The name of your Cloudflare Pages project.directory: The directory containing the assets to deploy (e.g., dist or public).gitHubToken: A GitHub token used to create GitHub Deployments and Deployment Statuses.branch: The branch to publish to. If not provided, it defaults to the branch that triggered the workflow.workingDirectory: The directory in which to run the deployment command.wranglerVersion: The version of wrangler to use for the deployment (e.g., a specific version number or a tag like beta).When the cloudflare/pages-action completes, it provides the following outputs that can be used in subsequent workflow steps:
| Name | Description |
|---|---|
id | The ID of the pages deployment |
url | The URL of the pages deployment |
alias | The alias if it exists; otherwise, the deployment URL |
environment | The environment that was deployed to |
The cloudflare/pages-action@v1 action accepts several configuration options in the with block:
| Option | Description |
|---|---|
apiToken | Required. Your Cloudflare API token with Cloudflare Pages — Edit permission. |
accountId | Required. Your Cloudflare Account ID. |
projectName | Required. The name of your Cloudflare Pages project. |
directory | Required. The directory containing your build output. |
gitHubToken | Optional. If provided, enables GitHub Deployments tracking. |
branch | Optional. The branch name used to determine if the deployment is production or preview. Defaults to the triggering branch. |
workingDirectory | Optional. The directory where Wrangler should run (useful for monorepos). |
wranglerVersion | Optional. Specifies the Wrangler version (e.g., '3'). |
After a successful execution, the action provides the following outputs which can be used in subsequent steps of your GitHub workflow:
id: The unique ID of the Cloudflare Pages deployment.url: The URL of the deployed site.environment: The environment associated with the deployment (e.g., production or preview).alias: The alias URL for the deployment. For preview deployments, this is typically the first available alias; for production, it is the main deployment URL.