Skip to content

feat: adding gh changelog/releases to npmx#1233

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

feat: adding gh changelog/releases to npmx#1233
WilcoSp wants to merge 175 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)
npmx.dev Ready Ready Preview, Comment Apr 18, 2026 1:22pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Apr 18, 2026 1:22pm
npmx-lunaria Ignored Ignored Apr 18, 2026 1:22pm

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 72.72727% with 15 lines in your changes missing coverage. Please review.
✅ All tests successful. No failed tests found.

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

📢 Thoughts on this report? Let us know!

Comment thread server/utils/changelog/markdown.ts Outdated
Comment thread server/utils/readme.ts Outdated
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.

looks good to me!

since its a big change, i'd like to see a 2nd approval before we merge

@WilcoSp
Copy link
Copy Markdown
Contributor Author

WilcoSp commented Apr 8, 2026

yeah probably a good idea, maybe also an idea is to merge after a release so that this get the maximum amount of time at main.npmx.dev so potential issues can be found, it'll also give translators the time to added text

@43081j
Copy link
Copy Markdown
Contributor

43081j commented Apr 8, 2026

we're moving more towards a feature schedule rather than a stream of merges going forward, so that'll likely be the case 👍

all good :D

@WilcoSp
Copy link
Copy Markdown
Contributor Author

WilcoSp commented Apr 11, 2026

I've just updated the command palette to include changelog & have the package specific commands available at changelog

Comment thread app/pages/package-changelog/[[org]]/[name].vue Outdated
Comment thread app/pages/package-changelog/[[org]]/[name].vue
Comment thread server/api/changelog/info/[...pkg].get.ts Outdated
span: prefixId,
section: prefixId,
article: prefixId,
},
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It seems to almost completely replicate the logic in utils/readme.ts except for the logic with link collection there. How about create a defaultSanitizeOptions (use this one) and reuse it in both places, but overwrite a there?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm going to save this for the next pr to prevent additional work from merge conflicts that come from potential changes in the utils/readme.ts.

The next planned pr for changelog is meant to make it that more code & logic are going to be shared between utils/readme.ts & utils/changelog/markdown.ts

@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

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