Skip to content

chore: standardize repository tooling#1229

Open
afc163 wants to merge 15 commits into
masterfrom
codex/standardize-rc-config
Open

chore: standardize repository tooling#1229
afc163 wants to merge 15 commits into
masterfrom
codex/standardize-rc-config

Conversation

@afc163

@afc163 afc163 commented Jun 26, 2026

Copy link
Copy Markdown
Member

Summary

  • Redesign README with a centered @rc-component/select header, package-specific emoji description, focused highlights, install, usage, examples, API, development, and release sections.
  • Restore the Bundlephobia minzip badge, keep the explicit npm install @rc-component/select command, and add a subtle Ant Design ecosystem note.
  • Mark README usage as a pure snippet so dumi preview builds do not compile it as a live demo.
  • Document the current prepublishOnly release flow.
  • Include dumi/father config files in TypeScript project scope.
  • Switch the primary rc-test reusable workflow to test-utoo.yml.
  • Add explicit Vercel preview configuration for the .doc dumi build output.
  • Add Surge Preview and optional Cloudflare Pages Preview fallback workflows.
  • Add the React Doctor GitHub Action for pull requests and pushes to master.
  • Normalize .github/FUNDING.yml to Ant Design sponsorship entries.
  • Update CodeQL to the current v4 action and pin touched actions to immutable SHAs, using checkout v7 with persisted credentials disabled.
  • Address AI review feedback by using the options prop in README usage and correcting SearchConfig defaults.

Compatibility

No runtime code changes. This should not introduce breaking changes.

Verification

  • npm run lint
  • npm test
  • npm run tsc
  • npm run compile
  • npm run build
  • git diff --check

Refs ant-design/ant-design#58514

Summary by CodeRabbit

  • New Features
    • 新增“React Doctor”与“Surge Preview”自动化流程:在提交/拉取请求触发时进行检查与文档预览;预览失败不阻断结果。
  • Documentation
    • 全面重写 README:更新徽标与 Badge、重构 Highlights 与 API 分区,明确搜索相关字段与 Deprecated 说明,并补充 Methods/配置/开发发布信息。
  • Bug Fixes
    • 调整 TypeScript 配置与编译范围,提升类型检查与构建一致性。
  • Chores
    • 更新脚本(新增/保留 tsc --noEmit、移除旧脚本)、优化 Vercel/预览输出配置,并精简 Funding;同步固定部分 CI/CodeQL 步骤版本与引用。

@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
select Ready Ready Preview, Comment Jun 27, 2026 2:27pm

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

新增 React Doctor 和 Surge Preview 工作流,更新现有 CI 引用与仓库配置,并重写 README 的结构、API 和发布信息。

Changes

项目自动化与文档更新

Layer / File(s) Summary
工作流与部署配置
.github/workflows/react-doctor.yml, .github/workflows/surge-preview.yml, vercel.json
新增 React Doctor 与 Surge Preview 工作流,并为 Vercel 补充安装、构建和输出目录配置。
现有 CI 引用更新
.github/workflows/codeql.yml, .github/workflows/test.yml
CodeQL 工作流的 action 版本改为固定提交哈希,测试工作流引用切换到新的复用文件。
仓库脚本与基础配置
.github/FUNDING.yml, package.json, tsconfig.json
package.json 的脚本列表更新,tsconfig.json 补充编译包含范围,.github/FUNDING.yml 精简为两个资助入口。
README 开头与使用说明
README.md
README 的标题、简介、徽标、Highlights、Install、Usage 和 Examples 章节被重写。
README API 参考
README.md
README 的 Select、Methods、SearchConfig、Option 与 OptGroup 参考表被重写。
README 结尾与发布信息
README.md
README 的 Development、Release 和 License 章节被重写。

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • zombieJ

Poem

(_/)
小兔蹦进新工作流,
README 换上整齐新目录,
预览、构建、发布一路通,
tsconfig 轻轻收好路径,
咔嚓一声,胡萝卜田更清爽了 ✨

🚥 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 codex/standardize-rc-config

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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md with modernized API documentation, usage examples, and development instructions, and updates tsconfig.json to include configuration and source directories. The review feedback suggests updating the README usage example to use the recommended 'options' prop instead of the legacy 'Option' component. Additionally, it points out that including '.fatherrc.js' in tsconfig.json without enabling 'allowJs' will cause a TypeScript compilation error.

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.

Comment thread README.md Outdated
Comment thread tsconfig.json Outdated
@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.50%. Comparing base (866e4d4) to head (767f342).
⚠️ Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1229      +/-   ##
==========================================
+ Coverage   99.44%   99.50%   +0.05%     
==========================================
  Files          31       31              
  Lines        1263     1406     +143     
  Branches      462      499      +37     
==========================================
+ Hits         1256     1399     +143     
  Misses          7        7              

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 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-doctor.yml:
- Around line 18-20: The checkout step is currently persisting the GitHub token
into local git config by default, which can expose credentials to later actions
in the same job. Update the actions/checkout@v5 usage in the workflow to
explicitly set persist-credentials to false alongside fetch-depth so the token
is not stored.
- Around line 18-21: The workflow currently uses mutable Action tags and leaves
checkout credentials persisted, so update the actions in the workflow to pinned
commit SHAs for both actions/checkout and millionco/react-doctor, and add
persist-credentials: false under the checkout step. Use the existing
actions/checkout and millionco/react-doctor steps to locate the changes.

In `@README.md`:
- Around line 86-96: The SearchConfig table is documenting incorrect defaults
for filterOption and optionFilterProp; only autoClearSearchValue has a real
runtime default. Update the README entry for SearchConfig so filterOption and
optionFilterProp no longer show default values (or mark them as none), and keep
the descriptions aligned with the actual behavior in the search config handling.
🪄 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: 1c17bf59-520f-4101-b8b8-3fe5bed8a7b8

📥 Commits

Reviewing files that changed from the base of the PR and between 866e4d4 and d9f9b8e.

📒 Files selected for processing (3)
  • .github/workflows/react-doctor.yml
  • README.md
  • tsconfig.json

Comment thread .github/workflows/react-doctor.yml Outdated
Comment thread .github/workflows/react-doctor.yml Outdated
Comment thread README.md
@afc163 afc163 force-pushed the codex/standardize-rc-config branch from d9f9b8e to f4de537 Compare June 26, 2026 03:36
@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown

✅ Preview is ready!

PR preview ✅ Ready ✅ Ready
🔗 Preview https://react-component-select-preview-pr-1229.surge.sh
📝 Commit767f342
⏱️ Build time25.868s
📦 Size2.0 MB · 150 files
🪵 LogsView logs
📱 MobileScan to open preview on mobile

↩️ Previous: ⚡️ 767f342 · react-component-select-preview-pr-1229.surge.sh (open ↗) · 2026-06-27 18:10:37 UTC

🤖 Powered by surge-preview

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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/surge-preview.yml:
- Around line 17-18: This workflow still uses floating action tags and leaves
checkout credentials persisted, which expands supply-chain and token exposure
risk. Update the `actions/checkout` step to disable credential persistence, and
pin both `actions/checkout` and `afc163/surge-preview` in the workflow to
immutable version identifiers (preferably full commit SHAs) so the exact action
code cannot drift over time.
🪄 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: 1c40c8a9-df2e-4cdb-a2c8-25fe24961083

📥 Commits

Reviewing files that changed from the base of the PR and between d9f9b8e and f4de537.

📒 Files selected for processing (5)
  • .github/workflows/react-doctor.yml
  • .github/workflows/surge-preview.yml
  • README.md
  • tsconfig.json
  • vercel.json
✅ Files skipped from review due to trivial changes (2)
  • tsconfig.json
  • README.md

Comment thread .github/workflows/surge-preview.yml Outdated
@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown

React Doctor found no new issues. 🎉

Reviewed by React Doctor for commit 767f342.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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/test.yml:
- Around line 5-6: The reusable workflow reference in the test workflow should
remain on the mutable `@main` ref and not be changed to a fixed SHA. Keep the
existing uses: react-component/rc-test/.github/workflows/test-utoo.yml@main and
secrets: inherit as-is, since the target workflow file exists and this is the
intended reusable-workflow setup.
🪄 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: bbcc46c7-1d3b-4d05-98b4-eecd4a82912e

📥 Commits

Reviewing files that changed from the base of the PR and between f4de537 and 9fec948.

📒 Files selected for processing (9)
  • .github/FUNDING.yml
  • .github/workflows/codeql.yml
  • .github/workflows/react-doctor.yml
  • .github/workflows/surge-preview.yml
  • .github/workflows/test.yml
  • README.md
  • package.json
  • tsconfig.json
  • vercel.json
✅ Files skipped from review due to trivial changes (2)
  • .github/FUNDING.yml
  • tsconfig.json
🚧 Files skipped from review as they are similar to previous changes (4)
  • vercel.json
  • .github/workflows/react-doctor.yml
  • .github/workflows/surge-preview.yml
  • README.md

Comment thread .github/workflows/test.yml
@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deployment failed with the following error:

Resource is limited - try again in 24 hours (more than 100, code: "api-deployments-free-per-day").

Learn More: https://vercel.com/react-component?upgradeToPro=build-rate-limit

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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/surge-preview.yml:
- Around line 19-24: In the Surge preview workflow, the current conditional
checks reference secrets.SURGE_TOKEN directly in if expressions, which breaks
workflow validation; move SURGE_TOKEN into a job-level env and update the
existing if guards to use env.SURGE_TOKEN instead. Apply this consistently to
the build step and the afc163/surge-preview action so the condition is evaluated
from env rather than secrets.

In `@tsconfig.json`:
- Line 16: The tsconfig include list is missing the root .fatherrc.js, so npm
run tsc will not type-check it. Update the include array in tsconfig.json to add
.fatherrc.js alongside .dumirc.ts, src, tests, and docs, keeping the change
localized to the tsconfig configuration.
🪄 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: 85288c03-1162-4ee2-acbb-7abadfca3928

📥 Commits

Reviewing files that changed from the base of the PR and between fad1773 and 9d55eef.

📒 Files selected for processing (3)
  • .github/workflows/surge-preview.yml
  • README.md
  • tsconfig.json
✅ Files skipped from review due to trivial changes (1)
  • README.md

Comment thread .github/workflows/surge-preview.yml Outdated
Comment thread tsconfig.json Outdated
@socket-security

socket-security Bot commented Jun 27, 2026

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednpm/​lint-staged@​16.4.010010010097100

View full report

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