Skip to content

ci: deploy docs after releases - #654

Merged
zombieJ merged 2 commits into
masterfrom
agent/fix-pages-deploy
Jul 27, 2026
Merged

ci: deploy docs after releases#654
zombieJ merged 2 commits into
masterfrom
agent/fix-pages-deploy

Conversation

@zombieJ

@zombieJ zombieJ commented Jul 27, 2026

Copy link
Copy Markdown
Member

Summary

  • build documentation with the GitHub Pages base path
  • deploy the current documentation whenever a release is published
  • use the shared rc Pages workflow from react-component/rc-test

Verification

  • GH_PAGES=1 ut run build
  • workflow YAML syntax validation
  • caller matches the organization workflow template

Summary by CodeRabbit

  • 新功能
    • 新增文档自动部署流程,支持发布版本后自动部署,也可手动触发。
  • 改进
    • 优化文档发布脚本,提升构建与部署流程在不同环境下的兼容性和稳定性。

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@zombieJ zombieJ self-assigned this Jul 27, 2026
@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cascader Ready Ready Preview, Comment Jul 27, 2026 7:24am

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

新增文档部署工作流,支持发布完成和手动触发;同时将部署脚本的构建环境变量从 UMI_ENV=gh 更换为 GH_PAGES=1

Changes

文档部署

Layer / File(s) Summary
部署入口与工作流配置
.github/workflows/deploy-pages.yml, package.json
部署脚本改用 cross-env GH_PAGES=1 构建并发布 docs-dist;新增具备最小权限并复用外部工作流的文档部署任务。

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: afc163

Poem

小兔挥挥胡萝卜,
文档乘风上云端。
GH_PAGES 点亮路,
发布按钮轻轻按。
新工作流,稳稳跑。

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 标题准确概括了在发布后部署文档的主要变更。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/fix-pages-deploy

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install timed out. The project may have too many dependencies for the sandbox.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown

React Doctor could not complete this scan.

react-doctor exited with status 0 before producing a JSON report.

Report this bug

Reviewed by React Doctor for commit 61cb6bd.

@codecov

codecov Bot commented Jul 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.39%. Comparing base (fd41111) to head (61cb6bd).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #654   +/-   ##
=======================================
  Coverage   99.39%   99.39%           
=======================================
  Files          22       22           
  Lines         661      661           
  Branches      204      203    -1     
=======================================
  Hits          657      657           
  Misses          4        4           

☔ 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.

@github-actions

github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown

❌ Deploy failed

PR preview ❌ Failed ❌ Failed
🔗 Preview https://react-component-cascader-preview-pr-654.surge.sh (may be unavailable)
📝 Commit61cb6bd
🪵 LogsView logs
📋 Build log (last lines)
npm error
npm error Could not resolve dependency:
npm error peer eslint@"^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9.7" from eslint-plugin-react@7.37.5
npm error node_modules/eslint-plugin-react
npm error   dev eslint-plugin-react@"^7.37.5" from the root project
npm error   eslint-plugin-react@"^7.32.2" from @umijs/fabric@4.0.1
npm error   node_modules/@umijs/fabric
npm error     @umijs/fabric@"^4.0.0" from rc-test@7.1.3
npm error     node_modules/rc-test
npm error       dev rc-test@"^7.1.3" from the root project
npm error
npm error Conflicting peer dependency: eslint@9.39.5
npm error node_modules/eslint
npm error   peer eslint@"^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9.7" from eslint-plugin-react@7.37.5
npm error   node_modules/eslint-plugin-react
npm error     dev eslint-plugin-react@"^7.37.5" from the root project
npm error     eslint-plugin-react@"^7.32.2" from @umijs/fabric@4.0.1
npm error     node_modules/@umijs/fabric
npm error       @umijs/fabric@"^4.0.0" from rc-test@7.1.3
npm error       node_modules/rc-test
npm error         dev rc-test@"^7.1.3" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /home/runner/.npm/_logs/2026-07-27T07_24_48_535Z-eresolve-report.txt
npm error A complete log of this run can be found in: /home/runner/.npm/_logs/2026-07-27T07_24_48_535Z-debug-0.log

🤖 Powered by surge-preview

@zombieJ zombieJ changed the title fix: correct GitHub Pages build path ci: deploy docs after releases Jul 27, 2026
@zombieJ
zombieJ marked this pull request as ready for review July 27, 2026 07:23
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/deploy-pages.yml:
- Line 15: 将 deploy-pages.yml 中可复用工作流的 uses 引用从 `@main` 更新为经过审核的不可变 commit
SHA,保留现有工作流路径不变,确保后续上游逻辑变化必须通过显式 SHA 更新引入。
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a7dcc7ab-e95f-4a49-bd5e-2e5a0ed8497c

📥 Commits

Reviewing files that changed from the base of the PR and between fd41111 and 61cb6bd.

📒 Files selected for processing (2)
  • .github/workflows/deploy-pages.yml
  • package.json


jobs:
deploy:
uses: react-component/rc-test/.github/workflows/deploy-pages.yml@main

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

git ls-remote https://github.com/react-component/rc-test.git refs/heads/main

Repository: react-component/cascader

Length of output: 219


将可复用工作流固定到不可变提交 SHA。

当前使用 @main,上游分支变化会在不更新本仓库的情况下改变 Pages 和 OIDC 部署逻辑。请将 react-component/rc-test/.github/workflows/deploy-pages.yml@main 替换为经过审核的 commit SHA,并在后续显式更新。

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/deploy-pages.yml at line 15, 将 deploy-pages.yml 中可复用工作流的
uses 引用从 `@main` 更新为经过审核的不可变 commit SHA,保留现有工作流路径不变,确保后续上游逻辑变化必须通过显式 SHA 更新引入。

Source: Learnings

@zombieJ
zombieJ merged commit 3c2bff8 into master Jul 27, 2026
12 of 15 checks passed
@zombieJ
zombieJ deleted the agent/fix-pages-deploy branch July 27, 2026 07:26
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.

1 participant