-
Notifications
You must be signed in to change notification settings - Fork 24
feat(index): support passing an index file #316
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
Conversation
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.
Pull Request Overview
This PR introduces support for passing an index file, refactoring the content loading and parsing pipelines and updating related tests and generators.
- Introduces a new loadFromURL utility to abstract content loading from both URLs and file paths.
- Adds new parser functions (parseChangelog and parseIndex) to handle changelog and sidebar data extraction from markdown.
- Updates the legacy HTML generator to support an index file and adjusts test commands in package.json accordingly.
Reviewed Changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/utils/parser.mjs | Adds loadFromURL function for abstracting content loading. |
| src/utils/tests/parser.test.mjs | Tests for the new loadFromURL function. |
| src/releases.mjs | Removal of legacy release handling code. |
| src/parsers/markdown.mjs | Adds parseChangelog and parseIndex for markdown parsing. |
| src/parsers/tests/markdown.test.mjs | Unit tests for the new markdown parser functions. |
| src/generators/legacy-html/index.mjs | Adjusts generator to use optional index file for sidebar creation. |
| package.json | Updates test commands to include experimental module mocks. |
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
❌ Your patch status has failed because the patch coverage (70.58%) is below the target coverage (80.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #316 +/- ##
==========================================
+ Coverage 50.02% 51.15% +1.12%
==========================================
Files 81 81
Lines 6942 6956 +14
Branches 296 306 +10
==========================================
+ Hits 3473 3558 +85
+ Misses 3466 3395 -71
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Ignore the codecov failure. It's because we don't have any tests covering our CLI, and it's only a reminder that our coverage is currently suboptimal, see #305 |
AugustinMauroy
left a comment
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.
LGMT !
flakey5
left a comment
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.
Thanks!
|
Requesting fast track as to not block the migration |
ovflowd
left a comment
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.
Overall LGTM, but left a few comments. Will approve after having them resolved.
7e16289 to
d20f49e
Compare
|
Just waiting for #318 to land for a green CI, then we should be good to land. |
Fixes #314
CC @flakey5
Ref: https://openjs-foundation.slack.com/archives/CVAMEJ4UV/p1750617708640369
This will allow us to use the Makefile's parallelism while still keeping the sidebar.