chore: standardize repository setup#568
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Walkthrough本 PR 更新了文档构建与发布路径，调整了多个 GitHub Actions 工作流，重写了英文与中文 README，修复了示例中的 TypeScript 类型封装，并同步升级了工具链、依赖与配置。 ChangesCI、部署与文档现代化
估计代码审查工作量🎯 3 (Moderate) | ⏱️ ~25 minutes 诗
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
✅ Preview is ready!
↩️ Previous: ⚡️ 🤖 Powered by surge-preview |
|||||||||||||||
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #568 +/- ##
=======================================
Coverage 98.94% 98.94%
=======================================
Files 8 8
Lines 190 190
Branches 69 69
=======================================
Hits 188 188
Misses 2 2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request cleans up the repository configuration and documentation. Key changes include updating the funding configurations, completely revamping the README with a modern layout and updated API tables, replacing the old static build configuration with a new vercel.json file, and updating several scripts in package.json (such as switching tsc from bunx to standard tsc and updating Husky/Prettier configurations). Feedback is provided to ensure consistency in the README's API table by using React.CSSProperties instead of CSSProperties.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
Deployment failed with the following error: Learn More: https://vercel.com/react-component?upgradeToPro=build-rate-limit |
|
React Doctor found no new issues. 🎉 Reviewed by React Doctor for commit |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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/react-component-ci.yml:
- Around line 5-6: 这处 reusable workflow 调用同时使用了可变引用和全量 secrets 继承，存在把当前仓库所有
secrets 暴露给外部工作流的风险；请在 .github/workflows/react-component-ci.yml 中把对
react-component/rc-test 的 workflow 引用从可变分支改为固定 SHA，并移除 secrets: inherit，改为只显式传递该
workflow 实际需要的最小 secrets 集合。
🪄 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
Run ID: a4af4be2-df7e-4d16-83fe-957b752c4bb8
📒 Files selected for processing (13)
.dumirc.ts.github/FUNDING.yml.github/workflows/codeql.yml.github/workflows/react-component-ci.yml.github/workflows/react-doctor.yml.github/workflows/surge-preview.ymlREADME.mdREADME.zh-CN.mddocs/examples/draggable.tsxnow.jsonpackage.jsontsconfig.jsonvercel.json
💤 Files with no reviewable changes (1)
- now.json
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.zh-CN.md (2)
73-75: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value
animation与transitionName并存，且className/classNames语义描述不一致。
- 第 73 行
animation与第 95 行transitionName功能重叠，请确认是否两者都存在于当前版本 API 中，或animation为旧版遗留。- 第 74 行
className描述为"附加对话框 className"，而第 75 行classNames描述为"语义 className"，两者描述风格不一致，建议统一为"附加的对话框 className"和"语义化的 className 配置"。🤖 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 `@README.zh-CN.md` around lines 73 - 75, The README API table has inconsistent prop documentation: `animation` and `transitionName` appear to overlap, and `className`/`classNames` use mismatched wording. Update the documentation around the Dialog props table so `animation` is either clearly marked as legacy/removed or aligned with `transitionName` in the same API surface, and standardize the descriptions in the Dialog prop entries for `className` and `classNames` using the same semantic style.
91-93: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value
scrollLock与styles描述格式不一致。
- 第 91 行
scrollLock："打开时是否锁定body滚动"中"body"未大写，建议改为"锁定 body 滚动"以符合技术术语规范。- 第 93 行
styles描述为"语义化样式"，而第 75 行classNames描述为"语义 className"，两者修饰词不一致（"语义化" vs "语义"），建议统一为"语义化的 className 配置"和"语义化的样式配置"。🤖 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 `@README.zh-CN.md` around lines 91 - 93, In the README.zh-CN prop table, normalize the wording for `scrollLock` and `styles` so the terminology is consistent with `classNames`. Update the `scrollLock` description to use “body” in a standard technical phrasing, and revise the `classNames`/`styles` descriptions to use the same “语义化的…” style. Make these wording changes in the relevant table entries only, keeping the existing props and structure intact.
🤖 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 `@README.zh-CN.md`:
- Around line 84-87: The遮罩相关文案在 README.zh-CN.md 中术语不一致且有误译，需要统一修正。请在表格中更新
`mask`、`maskAnimation`、`maskTransitionName` 这几个条目，确保 `mask`
的说明改为“是否显示遮罩”，`maskTransitionName` 的说明改为“遮罩过渡 className”，并检查 `maskAnimation` 与
`maskTransitionName` 是否都是有效 API 或是否存在旧命名需要同步说明。
---
Nitpick comments:
In `@README.zh-CN.md`:
- Around line 73-75: The README API table has inconsistent prop documentation:
`animation` and `transitionName` appear to overlap, and `className`/`classNames`
use mismatched wording. Update the documentation around the Dialog props table
so `animation` is either clearly marked as legacy/removed or aligned with
`transitionName` in the same API surface, and standardize the descriptions in
the Dialog prop entries for `className` and `classNames` using the same semantic
style.
- Around line 91-93: In the README.zh-CN prop table, normalize the wording for
`scrollLock` and `styles` so the terminology is consistent with `classNames`.
Update the `scrollLock` description to use “body” in a standard technical
phrasing, and revise the `classNames`/`styles` descriptions to use the same
“语义化的…” style. Make these wording changes in the relevant table entries only,
keeping the existing props and structure intact.
🪄 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
Run ID: 4cb05161-62fa-4d87-b87d-1227a118a5a7
📒 Files selected for processing (10)
.github/dependabot.yml.github/workflows/codeql.yml.github/workflows/react-doctor.yml.github/workflows/surge-preview.yml.gitignore.prettierignoreLICENSEREADME.mdREADME.zh-CN.mdpackage.json
✅ Files skipped from review due to trivial changes (4)
- LICENSE
- .prettierignore
- .gitignore
- README.md
🚧 Files skipped from review as they are similar to previous changes (3)
- .github/workflows/react-doctor.yml
- .github/workflows/surge-preview.yml
- package.json
There was a problem hiding this comment.
♻️ Duplicate comments (1)
.github/workflows/react-component-ci.yml (1)
8-9: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win这里会打破当前 reusable workflow 的 secrets 合约。
在
react-component/rc-test先声明workflow_call.secrets之前，这里把secrets: inherit收紧成只传CODECOV_TOKEN，会让当前共享工作流调用不再兼容。这个 PR 里更稳妥的做法是先保持secrets: inherit，等rc-test先完成合约升级后再一起收紧调用方。Based on learnings，react-component/rc-test/.github/workflows/test-utoo.yml目前还没有声明显式的workflow_call.secrets合约，调用方在它更新前需要继续使用secrets: inherit。#!/bin/bash set -euo pipefail tmp="$(mktemp)" trap 'rm -f "$tmp"' EXIT curl -fsSL \ https://raw.githubusercontent.com/react-component/rc-test/main/.github/workflows/test-utoo.yml \ -o "$tmp" echo "== workflow_call block ==" sed -n '/workflow_call:/,/^[^[:space:]]/p' "$tmp" echo echo "== secret references inside reusable workflow ==" rg -n '\bsecrets\.[A-Z0-9_]+\b' "$tmp" || true🤖 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/react-component-ci.yml around lines 8 - 9, 当前 reusable workflow 的 secrets 合约还没升级完成，直接把调用方收紧到只传 CODECOV_TOKEN 会破坏兼容性。请在这个工作流里保持 secrets: inherit，不要改成显式单个 secret 传递；等 react-component/rc-test 的 reusable workflow 先声明好 workflow_call.secrets 合约后，再同步收紧调用方。重点检查当前 workflow 的 secrets 配置和 rc-test 的 test-utoo.yml 调用契约是否一致。Source: Learnings
🤖 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.
Duplicate comments:
In @.github/workflows/react-component-ci.yml:
- Around line 8-9: 当前 reusable workflow 的 secrets 合约还没升级完成，直接把调用方收紧到只传
CODECOV_TOKEN 会破坏兼容性。请在这个工作流里保持 secrets: inherit，不要改成显式单个 secret 传递；等
react-component/rc-test 的 reusable workflow 先声明好 workflow_call.secrets
合约后，再同步收紧调用方。重点检查当前 workflow 的 secrets 配置和 rc-test 的 test-utoo.yml 调用契约是否一致。
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 453a7892-b0a4-4383-b103-97c71e6e2a94
📒 Files selected for processing (1)
.github/workflows/react-component-ci.yml
1 participant
Summary
Standardize this rc-component repository as part of the Ant Design rc-component maintenance sweep.
Tracking issue: ant-design/ant-design#58514
Scope
types: "./es/index.d.ts", publishConfig, and release flow through@rc-component/np.react-component/rc-test/.github/workflows/test-utoo.yml@mainworkflow, React Doctor, Codecov, CodeQL, updated GitHub Actions versions, and guarded Surge preview fallback.docs-distoutput and remove legacynow-build/ Cloudflare Pages residue.Notes
secrets: inheritis kept untilreact-component/rc-test#176is merged, then it can be narrowed to explicitCODECOV_TOKENforwarding.Summary by CodeRabbit