-
-
Notifications
You must be signed in to change notification settings - Fork 200
docs: fix online demo link #507
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: fix online demo link #507
Conversation
更新 vercel.json 配置文件以适配 Vercel 部署要求,并同步更新 README 中的 CI 徽章链接和在线演示地址
|
Someone is attempting to deploy a commit to the React Component Team on Vercel. A member of the Team first needs to authorize it. |
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 概览该变更涉及项目配置更新:GitHub Actions工作流引用改为最新路径,移除David-DM徽章,更新在线演示URL至Vercel部署地址;移除cross-env开发依赖;将Vercel配置从框架模式迁移至v2标准格式。 变更
预估代码审查工作量🎯 1 (简单) | ⏱️ ~8 分钟 建议审查者
诗
Pre-merge checks and finishing touches✅ Passed checks (3 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 |
Summary of ChangesHello @TaueFenCheng, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on essential maintenance tasks, ensuring the project's documentation remains accurate and its build infrastructure is optimized. It updates outdated links in the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
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 successfully updates the online demo link to a new Vercel-hosted URL, removes defunct dependency badges (David DM), and cleans up an unused npm package (cross-env). The GitHub Actions badge URL is also corrected. The configuration for Vercel deployment is added in vercel.json. The changes are logical and improve the project's maintenance. I have one suggestion to improve the consistency of the Vercel configuration.
| } | ||
| "$schema": "https://openapi.vercel.sh/vercel.json", | ||
| "version": 2, | ||
| "name": "@rc-component/tooltip", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name property in vercel.json is used for the Vercel project name. Using the scoped package name @rc-component/tooltip is unconventional and doesn't match the project name tooltip-react-component implied by the new demo URL (https://tooltip-react-component.vercel.app/). This inconsistency can cause confusion and issues when deploying or linking the project with the Vercel CLI. To improve clarity and consistency, it's recommended to use a name that matches the Vercel project.
| "name": "@rc-component/tooltip", | |
| "name": "tooltip-react-component", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(2 hunks)package.json(0 hunks)vercel.json(1 hunks)
💤 Files with no reviewable changes (1)
- package.json
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
65-65: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Socket Security: Pull Request Alerts
🔇 Additional comments (2)
vercel.json (1)
2-14: Vercel v2配置看起来良好。配置已正确迁移至Vercel v2标准。@vercel/static-build使用package.json作为依赖项获取和指定构建方式,期望输出到dist或通过distDir配置项指定的目录。
请确保 package.json 中已配置对应的
now-build脚本来生成 dist 目录的内容。README.md (1)
16-17: GitHub Actions工作流URL已正确更新。工作流路径已从旧的CI配置更新为新的
react-component-ci.yml,与Vercel部署迁移保持一致。
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #507 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 37 37
Branches 15 15
=========================================
Hits 37 37 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
fix online demo link & remove useless npm pkg
Summary by CodeRabbit
发版说明
文档更新
构建配置