dash.js
dash.js copied to clipboard
CHANGELOG: Use a single file format for releases?
Hi, thank you for the project!
Is your feature request related to a problem? Please describe. It's difficult to see what's happened across releases since they're separated and paginated
Describe the solution you'd like Use a one-file changelog so users can see changes without having to launch multiple tabs
Describe alternatives you've considered I think a one-file changelog is the only way to satisfy this
Additional context I think that GitHub releases obfuscates the developer's ability to understand changes across versions.
The release notes appear to be automated: other than categories features/improvements/etc. it doesn't distinguish internal improvements from stuff the maintainer deems important to alert end users to. e.g. a bug fix vs improving a unit test
For instance, in v4.4.1, it has JSDoc cleanup, and test updates - which is great - but its interspersed with things important to the user Overwrite manifest mediaPresentationDuration if duration mismatch.
For an idea of what I mean, I posted a similar issue to webpack a while back: https://github.com/webpack/webpack/issues/15318
Here's a video of what an end user sees with Releases vs a Changelog file: Link
I think that as an end user, there are two things I like to see:
-
A single file changelog, ideally linked to the git tag (moving forward)
-
Curating the changelog to spotlight what the release manager deems most important to end users
I think noting test improvements and documentation improvements is always encouraging to see (as it is with dash.js), but not always what I'd expect to read about first.