chore(guides): harden OG image generation + add web-build CI#2437
Merged
Conversation
Follow-up hardening on #2436 (which fixed the build-script order that caused OG images to be generated for only 39 of the 504 posts). Changes: - apps/guides/package.json - "build": runs build-content BEFORE generate-og-images (matches #2436) - "test:og": new script that builds content + OG images, then runs the end-to-end pipeline test - apps/guides/scripts/generate-og-images.ts - assertContentIsFresh(): runtime guard that throws a clear error when lib/content.ts has far fewer posts than there are MDX files on disk, catching the order-inversion bug if anyone reintroduces it - Documented the build-order requirement at the top of the file - apps/guides/__tests__/og-images.test.ts - End-to-end regression test: asserts public/og/*.png count matches lib/content.ts post count and that every PNG is valid (magic bytes, non-empty). Gated behind RUN_OG_PIPELINE_TEST=1 so it does not slow down the regular vitest suite. - apps/guides/README.md - New: documents the build pipeline and the four guard layers (build script order, runtime assert, vitest, CI workflow) - .github/workflows/web-builds.yml - New: builds apps/guides and apps/landing on every PR - Uploads out/ as a 7-day artifact for local inspection - Surfaces post count, OG image count, and out/ size in the GitHub Step Summary so reviewers do not have to depend on the Cloudflare Pages dashboard for build signal Lighthouse configs (.lighthouserc.{js,mobile.js}) already exist for both apps with conservative budgets (LCP <2500ms, CLS <0.1, perf >=0.8); no change needed. Verification: - bun check-types: 0 errors - bun x biome check on changed files: clean - bun run --cwd apps/guides build: generated 1 + 504 OG images - bun run --cwd apps/guides test:og: 4 passed Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
`apps/guides/__tests__/og-images.test.ts` reads `process.env.RUN_OG_PIPELINE_TEST` as a vitest-level skip gate, the same role `VITEST` plays in the existing nodeEnv schema. Adding a one-off env var to nodeEnvSchema for a test gate felt heavier than warranted, so this just exempts the single test file — matching the existing pattern for `packages/api/src/utils/__tests__/`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
documentation
Contributor
Deploying packrat-guides with
|
| Latest commit: |
cc3b2dc
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a6e81ddf.packrat-guides-6gq.pages.dev |
| Branch Preview URL: | https://chore-og-lighthouse-hardenin.packrat-guides-6gq.pages.dev |
Future-proofs for adding native (Expo / macOS) builds to the same workflow. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR hardens the guides OG-image pipeline by enforcing the content build order, adding an opt-in OG pipeline test, documenting the workflow, and introducing CI builds for the guides and landing static exports.
Changes:
- Reorders guides build steps and adds a freshness guard before OG image generation.
- Adds an opt-in OG image pipeline Vitest suite and documents the guides build pipeline.
- Adds a Web Builds GitHub Actions workflow with build summaries and artifacts.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
packages/env/scripts/no-raw-process-env.ts |
Allows the new OG pipeline test to read its opt-in environment flag. |
apps/guides/scripts/generate-og-images.ts |
Adds documentation and a runtime guard for stale generated content. |
apps/guides/README.md |
Documents build order, guards, and useful guides scripts. |
apps/guides/package.json |
Fixes build order and adds test:og. |
apps/guides/__tests__/og-images.test.ts |
Adds gated end-to-end assertions for generated OG PNGs. |
.github/workflows/web-builds.yml |
Adds CI jobs to build guides and landing, summarize outputs, and upload artifacts. |
Comments suppressed due to low confidence (1)
.github/workflows/web-builds.yml:33
- The push trigger has the same blind spot as the PR trigger: workspace packages used by the web apps are omitted from the path filter. Changes under
packages/guards,packages/env, orpackages/apican affectapps/guides/apps/landingbuilds but will not run this workflow onmain/development, reducing the reliability of the deployed-build signal.
paths:
- 'apps/guides/**'
- 'apps/landing/**'
- 'packages/web-ui/**'
- 'package.json'
- 'bun.lock'
- '.github/workflows/web-builds.yml'
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+60
to
+65
| if (mdxFileCount > MIN_MDX_FILES_FOR_GUARD && postCount < STALE_POST_THRESHOLD) { | ||
| throw new Error( | ||
| `generate-og-images: only ${postCount} posts found in lib/content.ts but ` + | ||
| `${mdxFileCount} MDX files exist in content/posts/. ` + | ||
| `Did you forget to run \`bun run build-content\` first? ` + | ||
| `The \`build\` script must run build-content BEFORE generate-og-images — see PR #2436.`, |
| "start": "next start", | ||
| "sync-to-r2": "bun run scripts/sync-to-r2.ts", | ||
| "test": "vitest run --config vitest.config.ts", | ||
| "test:og": "bun run build-content && bun run generate-og-images && RUN_OG_PIPELINE_TEST=1 vitest run --config vitest.config.ts __tests__/og-images.test.ts", |
Comment on lines
+76
to
+82
| const generatedPngs = fs.readdirSync(OG_DIR).filter((f) => f.endsWith('.png')); | ||
| expect( | ||
| generatedPngs.length, | ||
| `Expected ${expectedCount} per-post OG images (one per post in lib/content.ts), ` + | ||
| `got ${generatedPngs.length}. This usually means generate-og-images ran ` + | ||
| `before build-content — see PR #2436.`, | ||
| ).toBe(expectedCount); |
Comment on lines
+82
to
+85
| og_count=0 | ||
| if [ -d "$OG_DIR" ]; then | ||
| og_count=$(find "$OG_DIR" -maxdepth 1 -name '*.png' 2>/dev/null | wc -l | tr -d ' ') | ||
| fi |
Comment on lines
+18
to
+24
| paths: | ||
| - 'apps/guides/**' | ||
| - 'apps/landing/**' | ||
| - 'packages/web-ui/**' | ||
| - 'package.json' | ||
| - 'bun.lock' | ||
| - '.github/workflows/web-builds.yml' |
Comment on lines
+56
to
+57
| | `bun run test` | Lightweight vitest suite | | ||
| | `bun run test:og` | End-to-end OG image pipeline test (slow) | |
| "private": true, | ||
| "scripts": { | ||
| "build": "bun run generate-og-images && bun run build-content && next build", | ||
| "build": "bun run build-content && bun run generate-og-images && next build", |
This was referenced May 17, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Hardening on top of #2436 (the one-line build-script fix that swapped
build-contentandgenerate-og-imagesso OG images get generated forall 504 guides instead of the 39 last committed to
lib/content.ts).The user was tired of going back and forth on this and wanted it
hardened so the regression can't silently reappear, plus inspectable CI
build output independent of the Cloudflare Pages dashboard.
What this PR adds
1. Build-order guard (
apps/guides/scripts/generate-og-images.ts)A runtime
assertContentIsFresh()check at the top of the script:if there are >50 MDX files on disk but
lib/content.tsreports <50posts, the script throws a clear error pointing at PR #2436. Catches
the inversion bug in seconds instead of producing a stale build.
2. End-to-end OG pipeline test
(
apps/guides/__tests__/og-images.test.ts)Asserts that
public/og/*.pngcount matcheslib/content.tspostcount, the root
og-image.pngexists, and every PNG has valid magicbytes. Gated behind
RUN_OG_PIPELINE_TEST=1so the heavy ~500-imagegeneration doesn't run on every
bun run test. Invoked via:3. Web Builds GitHub Actions workflow (
.github/workflows/web-builds.yml)Builds
apps/guidesandapps/landingon every PR. The high-valuepiece: surfaces post count, OG image count, root OG image presence,
HTML page count, and
out/size in the GitHub Step Summary soreviewers see the CF-Pages-equivalent build signal directly in the PR
checks UI. Also uploads
out/as a 7-day artifact for local inspection.Includes inline warning rows in the summary if
lib/content.tslooksstale vs MDX files on disk, or if OG image count falls below post
count — making PR #2436-style regressions visible in the PR check
summary without anyone clicking through.
4. README (
apps/guides/README.md)Documents the build pipeline and the four guard layers:
build-script order, runtime assert, vitest, CI workflow.
5. Lint exemption (
packages/env/scripts/no-raw-process-env.ts)Adds the new test file to the
no-raw-process-envallowlist — samepattern as the existing
packages/api/src/utils/__tests__/entry.The test reads
process.env.RUN_OG_PIPELINE_TESTas a skip gate, atest-runner concern not worth adding to
nodeEnvSchema.What this PR does NOT change
.lighthouserc.{js,mobile.js}already exist forboth apps with conservative budgets (LCP <2500ms, CLS <0.1, perf >=0.8,
a11y/best-practices/seo >=0.9). No tightening needed — they're
already regression budgets.
apps/guides/lib/content.ts: intentionally left at the stale 39-poststate — fix(guides): build OG images for all 504 posts (was 39) #2436 is the antecedent that regenerates it on first build,
and including a regen here would conflict.
Verification
bun check-types: 0 errorsbun x biome checkon changed files: cleanbun run --cwd apps/guides build: produces 1 root + 504 per-post OGimages
bun run --cwd apps/guides test:og: 4 tests passedbun packages/env/scripts/no-raw-process-env.ts: cleanlefthook clean-checks): all greenTest plan
the Step Summary
guides-outartifact is downloadable from the workflow runtest:ogfails witha clear message pointing at fix(guides): build OG images for all 504 posts (was 39) #2436