You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I wanted to request some feedback on changelogs and I was wondering if anyone else finds having one file tied to git tags more efficient.
Personally I find it very difficult to appreciate the changes since releases spreads changes across pages and tabs. In a recent case I've updated to 5.37.1 to 5.61.0 and realized how deep I had to go instead of scrolling through a single page.
Benefits of CHANGELOG.md?
One file. Many are delighted when projects have CHANGELOG.md. Here is an example with webpack-dev-server:
This makes it possible to have a link that works, even months or years from now. In addition it includes multiple versions in between without needing to see collapsed changes and paginating through multiple pages.
Issues with GitHub Releases?
GitHub releases feels official - but as for developer usefulness they make it untenable to browse through updates.
They only support a few releases per page, but if it was a CHANGELOG.md you'd be able to ctrl-f and use your mouse wheel/cursor to scroll.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hi, Thank you for the project!
I wanted to request some feedback on changelogs and I was wondering if anyone else finds having one file tied to git tags more efficient.
Personally I find it very difficult to appreciate the changes since releases spreads changes across pages and tabs. In a recent case I've updated to 5.37.1 to 5.61.0 and realized how deep I had to go instead of scrolling through a single page.
Benefits of
CHANGELOG.md
?One file. Many are delighted when projects have
CHANGELOG.md
. Here is an example withwebpack-dev-server
:https://github.com/webpack/webpack-dev-server/blob/v4.4.0/CHANGELOG.md
(notice
v4.4.0
for the version tag)This makes it possible to have a link that works, even months or years from now. In addition it includes multiple versions in between without needing to see collapsed changes and paginating through multiple pages.
Issues with GitHub Releases?
GitHub releases feels official - but as for developer usefulness they make it untenable to browse through updates.
They only support a few releases per page, but if it was a CHANGELOG.md you'd be able to ctrl-f and use your mouse wheel/cursor to scroll.
This makes it impossible to understand the changelog. But if there was a
CHANGELOG.md
, someone could simply go to https://github.com/webpack/webpack-dev-server/blob/v5.61.0/CHANGELOG.md and scroll through what happened.Thoughts?
I was bringing this out there because I'm not sure if it's just me, or maybe I'm missing something!
Beta Was this translation helpful? Give feedback.
All reactions