Skip to content

feat: adding gh changelog/releases to npmx#1233

Open
WilcoSp wants to merge 186 commits intonpmx-dev:mainfrom
WilcoSp:feat/changelog-1
Open

feat: adding gh changelog/releases to npmx#1233
WilcoSp wants to merge 186 commits intonpmx-dev:mainfrom
WilcoSp:feat/changelog-1

Conversation

@WilcoSp
Copy link
Copy Markdown
Contributor

@WilcoSp WilcoSp commented Feb 8, 2026

This pr will add the possibility to view the changelog.md & releases from a package's github repo within npmx.
This will make it easier to see the changelogs while not needing to leave npmx and allowing quicker access.

This pr is the first pr of #501

Preview here, this will automatically update

Acknowledgements

While I was making this PR antfu also made this pr #1368 and here my comment from his pr

Also @ShroXd is currently working on adding changelogs to the version history page that was merged with #2025, we've both agreed to first independently work on our PRs and later after both are merged and we've received feedback & irl use we'll collaborate on the interaction between the two

Translations

Thanks @WarningImHack3r for translating the text for changelog to French
I've also added Dutch translations

@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 8, 2026

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

Project Deployment Actions Updated (UTC)
docs.npmx.dev Ready Ready Preview, Comment Apr 28, 2026 6:25pm
npmx.dev Ready Ready Preview, Comment Apr 28, 2026 6:25pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
npmx-lunaria Ignored Ignored Apr 28, 2026 6:25pm

Request Review

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 8, 2026

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
i18n/locales/en.json Source changed, localizations will be marked as outdated.
i18n/locales/fr-FR.json Localization changed, will be marked as complete. 🔄️
i18n/locales/kn-IN.json Localization changed, will be marked as complete. 🔄️
i18n/locales/nl.json Localization changed, will be marked as complete. 🔄️
i18n/locales/tr-TR.json Localization changed, will be marked as complete. 🔄️
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 8, 2026

Codecov Report

❌ Patch coverage is 63.07692% with 24 lines in your changes missing coverage. Please review.
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
app/components/Changelog/Card.vue 63.15% 7 Missing ⚠️
app/components/Package/Header.vue 41.66% 7 Missing ⚠️
app/utils/router.ts 0.00% 3 Missing and 2 partials ⚠️
...pp/composables/useCommandPalettePackageCommands.ts 72.72% 3 Missing ⚠️
app/pages/settings.vue 0.00% 1 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

@WilcoSp
Copy link
Copy Markdown
Contributor Author

WilcoSp commented Apr 17, 2026

I've merged main again to this pr branch, but with timeline added the package header menu now looks like this.
afbeelding

@WilcoSp
Copy link
Copy Markdown
Contributor Author

WilcoSp commented Apr 19, 2026

I'm currently still working on combining the shared code of the 2 markdown renderers in a separate branch.
to allow for feedback I've created this PR in my fork of npmx to show the chances.

@serhalp
Copy link
Copy Markdown
Member

serhalp commented Apr 20, 2026

I'm currently still working on combining the shared code of the 2 markdown renderers in a separate branch. to allow for feedback I've created this PR in my fork of npmx to show the chances.

@WilcoSp does that mean this PR shouldn't be reviewed at the moment?

@WilcoSp
Copy link
Copy Markdown
Contributor Author

WilcoSp commented Apr 20, 2026

@serhalp

@WilcoSp does that mean this PR shouldn't be reviewed at the moment?

This pr can be reviewed with how it's currently, I only plan for this to do merges from main, needed adjustements & bug fixes for this pr/branch.

I'm only starting with the next pr/branch already as to not stand still.
I'm only mentioning that I'm working on the next one because some did ask for the combining of the code of the markdown renderers and I would like to allow them to give early feedback

the new branch isn't meant to be merged into this branch/pr, but separately after this pr.

Comment thread server/api/changelog/info/[name]/v/latest.get.ts
@43081j
Copy link
Copy Markdown
Contributor

43081j commented Apr 29, 2026

left one minor comment but this generally looks good to me.

i think we need to move this on as its been continuously reviewed since Feb.

what'd be helpful:

  • another review from a maintainer, particularly of the general UX and the markdown logic
  • do any significant changes in follow up PRs unless they're truly a blocker here

@WilcoSp
Copy link
Copy Markdown
Contributor Author

WilcoSp commented Apr 29, 2026

for further significant changes I've already made a new branch (compare pr), the pr will be made after this pr gets merged.

I do hope that this pr can be merged soon because there are further plans.

Copy link
Copy Markdown
Contributor

@43081j 43081j left a comment

Choose a reason for hiding this comment

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

approving but please hold off merging until we get another approval as this is a big one.

Copy link
Copy Markdown
Contributor

@gameroman gameroman left a comment

Choose a reason for hiding this comment

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

Very good overall 🎉

One thing I noticed is there doesn't seem to be any loading indicator when opening the changelog page for the first time, but this can be done in the next PR

@WilcoSp
Copy link
Copy Markdown
Contributor Author

WilcoSp commented Apr 30, 2026

Yeah the skeletons loaders can be improved, currently they're only being shown when fetching data but not during server rendering of the changelog components due to not accounting for ssr.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs review This PR is waiting for a review from a maintainer ux Related to wider UX decisions

Projects

Status: Ready

Development

Successfully merging this pull request may close these issues.

10 participants