Skip to content

feat: deploy docs via Zephyr Cloud with PR preview environments#509

Draft
arthurfiorette with Copilot wants to merge 4 commits into
nextfrom
copilot/change-docs-deployment-to-zephyr
Draft

feat: deploy docs via Zephyr Cloud with PR preview environments#509
arthurfiorette with Copilot wants to merge 4 commits into
nextfrom
copilot/change-docs-deployment-to-zephyr

Conversation

Copilot AI commented Jul 8, 2026

Copy link
Copy Markdown

Replaces GitHub Pages with Zephyr Cloud for docs deployment and adds automatic PR preview environments.

Changes

  • packages/docs/package.json — add zephyr-rspress-plugin ^0.0.59
  • packages/docs/rspress.config.ts — register withZephyr() as first plugin; handles CDN upload during rspress build
  • .github/workflows/ci.yml — drop GitHub Pages permissions + deploy steps; pass ZE_SERVER_TOKEN secret to docs build
  • .github/workflows/preview-environments.yml (new) — builds docs on every PR and runs zephyr-preview-environment-action to post preview URLs as PR comments; skips build on closed events (cleanup only)

Required secret

Add ZE_SERVER_TOKEN (Zephyr org-level server token) to Settings → Secrets → Actions before merging.

Copilot AI changed the title feat: integrate Zephyr Cloud for docs deployment and PR previews feat: deploy docs via Zephyr Cloud with PR preview environments Jul 8, 2026
@changeset-bot

changeset-bot Bot commented Jul 8, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 911b2a0

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/preview-environments.yml Outdated
@codecov

codecov Bot commented Jul 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.40%. Comparing base (cb5a8ee) to head (2283ce0).

Additional details and impacted files
@@           Coverage Diff           @@
##             next     #509   +/-   ##
=======================================
  Coverage   95.40%   95.40%           
=======================================
  Files          13       13           
  Lines         479      479           
  Branches      137      137           
=======================================
  Hits          457      457           
  Misses         20       20           
  Partials        2        2           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

},

plugins: [
withZephyr(),

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

For the deployment process to work, you will need to add ZE_CI_TOKEN to the list of turbo.json environment variables to pass on to the execution layer.

run: pnpm turbo build -F @kitajs/docs-html

- name: Zephyr Preview Environments
uses: ZephyrCloudIO/zephyr-preview-environment-action@v0.1.1

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bump the preview action to v0.2.0

@arthurfiorette

Copy link
Copy Markdown
Member

@copilot pls fix @ryok90 review comments

Copilot AI commented Jul 8, 2026

Copy link
Copy Markdown
Author

@copilot pls fix @ryok90 review comments

Both addressed in the latest commit:

  • ZE_CI_TOKEN added to the build task env in turbo.json so Turbo forwards it to the execution layer
  • Preview action bumped to v0.2.0

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.

3 participants