Repository navigation
refactor: use cf and deploy previews #55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Deploys each pull request's docs site as a Worker Preview of the `docs` | ||
| # Worker and comments the preview URL on the pull request. The preview is | ||
| # named after the branch, so new pushes update the same preview. | ||
| # | ||
| # Pull requests from forks are skipped: they get no repository secrets. | ||
| # CI's checks still build them. | ||
|
|
||
| name: Preview docs | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [main] | ||
| paths: | ||
| - 'packages/astro-fern/**' | ||
| - 'packages/fern-forge/**' | ||
| - 'packages/cloudflare-api-site/**' | ||
| - 'pnpm-lock.yaml' | ||
| - '.github/workflows/preview-docs.yml' | ||
|
|
||
| concurrency: | ||
| group: preview-docs-${{ github.event.pull_request.number }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| preview: | ||
| name: Preview docs | ||
| if: github.event.pull_request.head.repo.full_name == github.repository | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 15 | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v7.0.1 | ||
|
|
||
| - uses: ./.github/actions/setup-workspace | ||
|
|
||
| # Preview URLs come from `previewUrls` in cloudflare.config.ts, which a | ||
| # production deploy must apply first. | ||
| - name: Deploy preview | ||
| run: pnpm --filter cloudflare-api-site run deploy:preview | tee "$RUNNER_TEMP/preview.log" | ||
| env: | ||
| CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} | ||
| CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }} | ||
|
|
||
| # TODO: uncomment once we're out of experimental | ||
| # The build logs to stdout too; the JSON result is the last top-level | ||
| # object in the output. | ||
| # - name: Comment preview URL | ||
| # env: | ||
| # GH_TOKEN: ${{ github.token }} | ||
| # PR: ${{ github.event.pull_request.number }} | ||
| # SHA: ${{ github.event.pull_request.head.sha }} | ||
| # run: | | ||
| # url=$(node -e ' | ||
| # const log = require("node:fs").readFileSync(process.argv[1], "utf8"); | ||
| # const start = log.lastIndexOf("\n{"); | ||
| # const result = JSON.parse(log.slice(start + 1)); | ||
| # const url = result.preview_urls?.[0] ?? result.deployment_urls?.[0]; | ||
| # if (!url) throw new Error("No preview URL in cf output"); | ||
| # console.log(url); | ||
| # ' "$RUNNER_TEMP/preview.log") | ||
| # body="Docs preview for ${SHA}: ${url%/}/api/" | ||
| # echo "$body" >> "$GITHUB_STEP_SUMMARY" | ||
| # gh pr comment "$PR" --repo "$GITHUB_REPOSITORY" --edit-last --create-if-none --body "$body" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| dist/ | ||
| .astro/ | ||
| .cloudflare/ | ||
| .wrangler/ | ||
| public/_astro-fern/ | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import { defineConfig } from 'cf/config'; | ||
|
|
||
| export default defineConfig({ | ||
| worker: { | ||
| name: 'docs', | ||
| compatibilityDate: '2026-07-21', | ||
| compatibilityFlags: ['nodejs_compat'], | ||
| domains: ['docs.experiments.devprod.cloudflare.dev'], | ||
| // Serve Worker Previews at <preview-name>-docs.<subdomain>.workers.dev. | ||
| // Takes effect once a production deploy applies it. | ||
| previewUrls: true, | ||
| }, | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| import { expect, test } from '@playwright/test'; | ||
|
|
||
| const operation = '/api/zero-trust/devices/ip-profiles/methods/list/'; | ||
|
|
||
| test.describe('routes', () => { | ||
| const routes: [path: string, status: number, contentType: string][] = [ | ||
| ['/api/', 200, 'text/html'], | ||
| ['/api/zero-trust/', 200, 'text/html'], | ||
| ['/api/zero-trust/devices/ip-profiles/', 200, 'text/html'], | ||
| [operation, 200, 'text/html'], | ||
| [`${operation}?lang=typescript`, 200, 'text/html'], | ||
| [`${operation}?lang=nope`, 404, 'text/plain'], | ||
| ['/api/zero-trust/devices/ip-profiles/methods/list.md', 200, 'text/markdown'], | ||
| ['/api/zero-trust/devices/ip-profiles/methods/list.md?lang=typescript', 200, 'text/markdown'], | ||
| ['/api/llms.txt', 200, 'text/markdown'], | ||
| ['/api/zero-trust/llms.txt', 200, 'text/markdown'], | ||
| ['/api/tooling/', 200, 'text/html'], | ||
| ['/api/.well-known/ard.json', 200, 'application/json'], | ||
| ['/api/nope.txt', 404, 'text/html'], | ||
| ]; | ||
|
|
||
| for (const [path, status, contentType] of routes) { | ||
| test(`${path} responds ${status} ${contentType}`, async ({ request }) => { | ||
| const response = await request.get(path, { maxRedirects: 0 }); | ||
| expect(response.status()).toBe(status); | ||
| expect(response.headers()['content-type']).toContain(contentType); | ||
| }); | ||
| } | ||
| }); | ||
|
|
||
| test('overview renders with product navigation', async ({ page }) => { | ||
| await page.goto('/api/'); | ||
| await expect(page).toHaveTitle('API Reference | Cloudflare API'); | ||
| await expect(page.locator('main h1')).toBeVisible(); | ||
| // Products are listed in the sidebar, collapsed by default. | ||
| await expect(page.locator('a[href="/api/zero-trust/"]').first()).toBeAttached(); | ||
| }); | ||
|
|
||
| test('operation page renders the operation and its samples', async ({ page }) => { | ||
| await page.goto(operation); | ||
| await expect(page).toHaveTitle('List IP profiles | Cloudflare API'); | ||
| await expect(page.locator('h1')).toHaveText('List IP profiles'); | ||
| await expect(page.locator('.forge-verb')).toHaveText('GET'); | ||
| await expect(page.locator('.forge-sample-code code.language-bash').first()).toContainText( | ||
| 'https://api.cloudflare.com/client/v4/accounts/', | ||
| ); | ||
| }); | ||
|
|
||
| test('execution target selector switches the code sample', async ({ page }) => { | ||
| await page.goto(operation); | ||
| const target = page.locator('select[data-forge-target]'); | ||
| await expect(target).toHaveValue('curl'); | ||
| await target.selectOption('typescript'); | ||
| await expect(page).toHaveURL(/[?&]lang=typescript\b/); | ||
| await expect(page.locator('select[data-forge-target]')).toHaveValue('typescript'); | ||
| await expect(page.locator('.forge-sample-code code.language-bash')).toHaveCount(0); | ||
| }); | ||
|
|
||
| test('operation links its agent Markdown', async ({ page, request }) => { | ||
| await page.goto(operation); | ||
| const href = await page.locator('link[rel="alternate"][type="text/markdown"]').getAttribute('href'); | ||
| expect(href).not.toBeNull(); | ||
| const response = await request.get(new URL(href!).pathname); | ||
| expect(response.status()).toBe(200); | ||
| const markdown = await response.text(); | ||
| expect(markdown).toContain('# List IP profiles'); | ||
| expect(markdown).toContain('- Path: `/accounts/{account_id}/devices/ip-profiles`'); | ||
| }); | ||
|
|
||
| test('llms.txt indexes the API', async ({ request }) => { | ||
| const response = await request.get('/api/llms.txt'); | ||
| expect(await response.text()).toMatch(/^# Cloudflare API\n/); | ||
| }); | ||
|
|
||
| test('unknown pages render the not-found page', async ({ page }) => { | ||
| const response = await page.goto('/api/nope.txt'); | ||
| expect(response?.status()).toBe(404); | ||
| await expect(page).toHaveTitle('Page not found | Cloudflare API'); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that
cf previews deploysupportWRANGLER_OUTPUT_FILE_DIRECTORYenv var, that results in a nice clean JSONL file being written to disk. So you don't have to rely upon the stdout.That being said, I think that after cloudflare/cf#355 we might have a clean stdout with the build logs sent to stderr??
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to know! For now I commented out the deploy preview because the site is still internal, and I don't want to leak it (I deleted the comment too)