docs(changelog): prepare v0.3.7 release - #89
Conversation
📝 WalkthroughWalkthroughThe changelog now includes a dated 0.3.7 release entry. It documents one breaking change and three feature updates. ChangesRelease documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 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 |
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 `@CHANGELOG.md`:
- Around line 31-34: Update the “Canonical MPA Document URLs” changelog entry to
clarify that semantic routes are retained only as page-resolution metadata, not
as public MPA URLs; explicitly state that `.html` URLs are the canonical public
URLs.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| - **Canonical MPA Document URLs** — MPA Pages now materialize as `index.html`, | ||
| `about.html`, and nested `foo/bar.html` Documents while retaining their | ||
| semantic routes. Development SSR and PPR requests use the same public URLs | ||
| and resolve back to their canonical Pages. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify that semantic routes are not public MPA URLs.
The server test in packages/server/tests/app.test.ts:1104-1138 returns 200 for /index.html and /about.html, but returns 404 for / and /about. The phrase “while retaining their semantic routes” can imply that the non-.html URLs remain public.
State that semantic routes remain page-resolution metadata, while .html URLs are the canonical public MPA URLs.
Proposed wording
-- **Canonical MPA Document URLs** — MPA Pages now materialize as `index.html`,
- `about.html`, and nested `foo/bar.html` Documents while retaining their
- semantic routes. Development SSR and PPR requests use the same public URLs
- and resolve back to their canonical Pages.
+- **Canonical MPA Document URLs** — MPA Pages now materialize as `index.html`,
+ `about.html`, and nested `foo/bar.html` Documents. Their semantic routes
+ remain available for page resolution, but the `.html` URLs are the canonical
+ public URLs for development SSR and PPR requests.As per coding guidelines, documentation should prefer declarative current behavior.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Canonical MPA Document URLs** — MPA Pages now materialize as `index.html`, | |
| `about.html`, and nested `foo/bar.html` Documents while retaining their | |
| semantic routes. Development SSR and PPR requests use the same public URLs | |
| and resolve back to their canonical Pages. | |
| - **Canonical MPA Document URLs** — MPA Pages now materialize as `index.html`, | |
| `about.html`, and nested `foo/bar.html` Documents. Their semantic routes | |
| remain available for page resolution, but the `.html` URLs are the canonical | |
| public URLs for development SSR and PPR requests. |
🤖 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 `@CHANGELOG.md` around lines 31 - 34, Update the “Canonical MPA Document URLs”
changelog entry to clarify that semantic routes are retained only as
page-resolution metadata, not as public MPA URLs; explicitly state that `.html`
URLs are the canonical public URLs.
Source: Coding guidelines
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7d3144f692
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - **Canonical MPA Document URLs** — MPA Pages now materialize as `index.html`, | ||
| `about.html`, and nested `foo/bar.html` Documents while retaining their | ||
| semantic routes. Development SSR and PPR requests use the same public URLs | ||
| and resolve back to their canonical Pages. |
There was a problem hiding this comment.
Mark the MPA URL replacement as breaking
Move this entry under Breaking Changes: applications upgrading from 0.3.6 that deploy, link to, or configure hosting around an MPA output such as report/index.html must migrate to report.html, and request-time semantic URLs such as /report also stop resolving. Classifying this replacement only as a feature hides a required deployment and URL migration from readers scanning the breaking-change section.
Useful? React with 👍 / 👎.
Summary
mainbranch.Changes
.htmlDocument URLs.Validation
npm run lintnpm --workspace evjs-docs run buildgit diff --checkRisk / rollout
v0.3.7after merge will publish all public@evjs/*workspaces with the npmlatestdist-tag.Reviewer notes
v0.3.6..main(PRs feat(utoopack): support multiple server entries #72, feat(ev): 支持插件驱动的开发 CLI 快捷键 #86, refactor(dev): replace dynamic updates with immutable sessions #87, and feat(mpa): support .html document URLs #88).main.Summary by CodeRabbit