docs: add version differences for proxy config#7119
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Summary of ChangesHello @chenjiahan, 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 enhances the documentation for Rsbuild's server proxy configuration by detailing the differences in proxy behavior between Rsbuild v1 and v2. The update addresses changes stemming from an upgrade in the underlying 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
|
Deploying rsbuild with
|
| Latest commit: |
22b87bb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://743d6e80.rsbuild-v2.pages.dev |
| Branch Preview URL: | https://proxy-doc-version-0202.rsbuild-v2.pages.dev |
![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 adds documentation clarifying the proxy configuration differences between Rsbuild v1 and v2. This is a valuable change for users migrating between versions. My review focuses on improving the clarity and correctness of the code examples provided. The current examples use duplicate keys in an object literal, which is invalid and could be confusing. I've suggested replacing them with separate, valid code blocks for each version to make the documentation clearer.
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to clarify the breaking changes in proxy configuration between Rsbuild v1 and v2, specifically related to the upgrade of the underlying http-proxy-middleware library from v2 to v3. The key behavioral change is that v3 no longer automatically appends the proxied path to the target URL, requiring explicit path inclusion in the target configuration.
Changes:
- Added "Version differences" section to both English and Chinese proxy configuration documentation
- Documented the breaking change in path handling between http-proxy-middleware v2 and v3
- Provided code examples showing the difference between v2 and v3 configurations
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| website/docs/zh/config/server/proxy.mdx | Added Chinese documentation explaining proxy config version differences with example |
| website/docs/en/config/server/proxy.mdx | Added English documentation explaining proxy config version differences with example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 participant
Summary
Clarify differences in proxy configuration between Rsbuild v1 and v2, specifically regarding changes in the underlying
http-proxy-middlewarelibrary.Related Links
Checklist