mirror of
https://github.com/cloudflare/pages-action
synced 2024-11-23 19:36:42 +00:00
.github/workflows | ||
.husky | ||
example | ||
src | ||
.gitignore | ||
action.yml | ||
index.js | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md |
Cloudflare Pages GitHub Action
GitHub Action for creating Cloudflare Pages deployments, using the new Direct Upload feature and Wrangler integration.
Usage
-
Create an API token in the Cloudflare dashboard with the "Cloudflare Pages — Edit" permission.
-
Add that API token as a secret to your GitHub repository,
CLOUDFLARE_API_TOKEN
. -
Create a
.github/workflows/publish.yml
file in your repository: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 a build step here if your project requires - name: Publish to Cloudflare Pages uses: cloudflare/pages-action@1 with: apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} accountId: YOUR_ACCOUNT_ID projectName: YOUR_PROJECT_NAME directory: YOUR_ASSET_DIRECTORY gitHubToken: ${{ secrets.GITHUB_TOKEN }}
-
Replace
YOUR_ACCOUNT_ID
,YOUR_PROJECT_NAME
andYOUR_ASSET_DIRECTORY
with the appropriate values to your Pages project.
More information can be found on our guide for making Direct Upload deployments with continous integration.