Skip to content

ci: deploy Vite demo to GitHub Pages#297

Merged
bdhyv merged 3 commits into
mainfrom
YPE-1434-deploy-demo-app-pages
Jul 21, 2026
Merged

ci: deploy Vite demo to GitHub Pages#297
bdhyv merged 3 commits into
mainfrom
YPE-1434-deploy-demo-app-pages

Conversation

@bdhyv

@bdhyv bdhyv commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • deploy the standalone Vite React SDK demo to GitHub Pages on changes to the example or SDK packages
  • configure the /platform-sdk-react/ asset base and include Vite build variables in Turbo's cache key
  • document the hosted demo URL
  • supersede ci: deploy Storybook to GitHub Pages #296; Storybook is intentionally excluded from Pages

Setup after merge

  • enable GitHub Pages with GitHub Actions as the source
  • set the YVP_DEMO_APP_KEY repository variable
  • register https://youversion.github.io/platform-sdk-react/ as a callback URL for that Platform app

Test plan

  • pnpm --filter vite-react lint
  • Pages-targeted pnpm turbo build --filter vite-react
  • verify generated asset URLs use /platform-sdk-react/
  • serve and load the production artifact under /platform-sdk-react/

YPE-1434

Made with Cursor

Greptile Summary

This PR deploys the Vite React SDK demo to GitHub Pages. The main changes are:

  • Adds a Pages build and deployment workflow for pushes to main.
  • Validates the demo app key before building.
  • Configures the /platform-sdk-react/ Vite base path.
  • Adds Vite variables to the Turbo build cache key.
  • Documents the hosted demo URL.

Confidence Score: 5/5

This looks safe to merge.

  • The workflow now fails before deployment when the app key is missing.
  • Removing the path filter ensures shared tooling changes on main trigger a fresh deployment workflow.
  • No remaining blocking issue meets the scope for this follow-up review.

Important Files Changed

Filename Overview
.github/workflows/deploy-demo.yml Adds the Pages workflow, rejects a missing app key, and runs for every push to main.
examples/vite-react/vite.config.ts Uses a configurable Vite base path with / as the default.
turbo.json Includes the deployment-specific Vite variables in build cache keys.
examples/vite-react/README.md Adds the hosted GitHub Pages demo URL.

Reviews (2): Last reviewed commit: "ci: harden Pages demo deployment (YPE-14..." | Re-trigger Greptile

Context used (4)

  • Context used - CLAUDE.md (source)
  • Context used - AGENTS.md (source)
  • File used - docs/review-guidelines.md (source)
  • Context used - Enforce project-specific review guidelines - see d... (source)

Publish the standalone example app from main so developers can evaluate the SDK without cloning the repository.

Co-authored-by: Cursor <cursoragent@cursor.com>
@changeset-bot

changeset-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 9564ccd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Comment thread .github/workflows/deploy-demo.yml
Comment thread .github/workflows/deploy-demo.yml Outdated
Fail fast when required configuration is missing and redeploy on every main update so the hosted demo cannot become stale.

Co-authored-by: Cursor <cursoragent@cursor.com>
@bdhyv
bdhyv requested a review from cameronapak July 21, 2026 17:26

@cameronapak cameronapak left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@bdhyv
bdhyv merged commit 1e2a90f into main Jul 21, 2026
7 checks passed
@bdhyv
bdhyv deleted the YPE-1434-deploy-demo-app-pages branch July 21, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants