Add cloudflare-pages-preview composite actions
Two composite actions extracted from modelcontextprotocol's blog-preview workflow: - deploy: injects noindex headers/meta, deploys to CF Pages under a per-PR branch alias, posts/updates a sticky PR comment with preview URLs - cleanup: deletes all CF Pages deployments for the PR branch alias on close, updates the sticky comment Callers provide a pre-built static HTML directory; the actions handle everything Cloudflare-specific.
This commit is contained in:
Den Delimarsky
parent
12edb490d8
commit
d0955aa69d
1 changed files with 354 additions and 0 deletions
126
cloudflare-pages-preview/README.md
Normal file
126
cloudflare-pages-preview/README.md
Normal file
|
|
@ -0,0 +1,126 @@
|
|||
# cloudflare-pages-preview
|
||||
|
||||
Reusable composite actions for deploying **PR previews** to Cloudflare Pages
|
||||
and cleaning them up when the PR closes.
|
||||
|
||||
## What it does
|
||||
|
||||
- **`deploy`** — Takes a pre-built static HTML directory and:
|
||||
1. Injects `X-Robots-Tag: noindex` headers (via `_headers`) and a
|
||||
`<meta name="robots" content="noindex">` tag into every HTML page so
|
||||
previews aren't crawled by search engines (optional, on by default)
|
||||
2. Deploys to Cloudflare Pages under a per-PR branch alias
|
||||
(`pr-<number>` by default) giving a stable URL across force-pushes
|
||||
3. Posts or updates a sticky PR comment with the preview URLs
|
||||
|
||||
- **`cleanup`** — On PR close:
|
||||
1. Deletes all Cloudflare Pages deployments for the PR's branch alias
|
||||
2. Updates the sticky PR comment to indicate cleanup
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A **Cloudflare Pages project** must be created in the Cloudflare dashboard
|
||||
first. Pass its name as `project-name`.
|
||||
- A **Cloudflare API token** with `Pages:Edit` permission scoped to that
|
||||
project. Do not reuse a general-purpose token.
|
||||
- GitHub Actions secrets for the token and account ID.
|
||||
|
||||
## Caller workflow requirements
|
||||
|
||||
The calling workflow must configure:
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Permissions** | `contents: read`, `pull-requests: write` |
|
||||
| **Fork-PR guard** | `if: github.event.pull_request.head.repo.full_name == github.repository` — forks do not have access to secrets, so deploys would fail anyway |
|
||||
| **Concurrency** | Per-PR group with `cancel-in-progress: true` to avoid racing deploys |
|
||||
| **Build** | Caller is responsible for checkout + building the static site before calling `deploy` |
|
||||
|
||||
## Usage
|
||||
|
||||
```yaml
|
||||
name: Preview
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened, closed]
|
||||
paths:
|
||||
- "site/**"
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: write
|
||||
|
||||
concurrency:
|
||||
group: preview-${{ github.event.pull_request.number }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build-and-deploy:
|
||||
if: >-
|
||||
github.event.action != 'closed' &&
|
||||
github.event.pull_request.head.repo.full_name == github.repository
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
# ... your build steps — produce static HTML in site/public ...
|
||||
|
||||
- uses: modelcontextprotocol/actions/cloudflare-pages-preview/deploy@main
|
||||
with:
|
||||
directory: site/public
|
||||
project-name: my-cf-pages-project
|
||||
api-token: ${{ secrets.CF_PREVIEW_API_TOKEN }}
|
||||
account-id: ${{ secrets.CF_PREVIEW_ACCOUNT_ID }}
|
||||
|
||||
cleanup:
|
||||
if: >-
|
||||
github.event.action == 'closed' &&
|
||||
github.event.pull_request.head.repo.full_name == github.repository
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: modelcontextprotocol/actions/cloudflare-pages-preview/cleanup@main
|
||||
with:
|
||||
project-name: my-cf-pages-project
|
||||
api-token: ${{ secrets.CF_PREVIEW_API_TOKEN }}
|
||||
account-id: ${{ secrets.CF_PREVIEW_ACCOUNT_ID }}
|
||||
```
|
||||
|
||||
Note: `cleanup` does **not** require `actions/checkout` — it only calls the
|
||||
Cloudflare API and GitHub API.
|
||||
|
||||
## Inputs
|
||||
|
||||
### `deploy`
|
||||
|
||||
| Input | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `directory` | ✅ | — | Path to built static HTML |
|
||||
| `project-name` | ✅ | — | Cloudflare Pages project name |
|
||||
| `api-token` | ✅ | — | Cloudflare API token (`Pages:Edit`) |
|
||||
| `account-id` | ✅ | — | Cloudflare account ID |
|
||||
| `branch` | | `pr-<PR number>` | CF Pages branch alias |
|
||||
| `inject-noindex` | | `'true'` | Inject `_headers` + `<meta>` noindex |
|
||||
| `comment-marker` | | `<!-- cf-pages-preview -->` | Sticky-comment identifier |
|
||||
| `comment-title` | | `Preview Deployed` | Heading in PR comment |
|
||||
| `github-token` | | `${{ github.token }}` | Token for PR commenting |
|
||||
|
||||
### `cleanup`
|
||||
|
||||
| Input | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `project-name` | ✅ | — | Cloudflare Pages project name |
|
||||
| `api-token` | ✅ | — | Cloudflare API token (`Pages:Edit`) |
|
||||
| `account-id` | ✅ | — | Cloudflare account ID |
|
||||
| `branch` | | `pr-<PR number>` | CF Pages branch alias to delete |
|
||||
| `comment-marker` | | `<!-- cf-pages-preview -->` | Sticky-comment identifier |
|
||||
| `github-token` | | `${{ github.token }}` | Token for PR commenting |
|
||||
|
||||
## Outputs
|
||||
|
||||
### `deploy`
|
||||
|
||||
| Output | Description |
|
||||
|---|---|
|
||||
| `deployment-url` | URL of this specific deployment (changes per push) |
|
||||
| `alias-url` | Stable branch-alias URL (same across pushes) |
|
||||
Loading…
Reference in a new issue