search

redis / node-redis

Redis Node.js client
https://redis.js.org/
MIT License
16.92k stars 1.89k forks source link

Changelog #2695

Open OP-Klaus opened 9 months ago

OP-Klaus commented 9 months ago

Thanks for this library and your efforts, I really appreciate it. I saw the conversation in https://github.com/redis/node-redis/issues/2301 but I still think there is a problem with the release process. There is the releases page which lists the versions of things that got bumped https://github.com/redis/node-redis/releases but there are no descriptions of changes.

As an example, the latest release is https://github.com/redis/node-redis/releases/tag/redis%404.6.12 and that has a changelog of Upgrade @redis/client from 1.5.121 to 1.5.13. Ok that's fine, so I go onto NPM to try to find what changed between those releases https://www.npmjs.com/package/@redis/client. NPM lists the homepage as https://github.com/redis/node-redis/tree/master/packages/client and the readme in there says "The source code and documentation for this package are in the main node-redis repo." which is this, so it all leads back to here in a circle and I still don't know what changed. I can manually compare the changes https://github.com/redis/node-redis/compare/redis%404.6.11...redis%404.6.12 and see that the change is really fix https://github.com/redis/node-redis/issues/2665 - handle errors in multi/pipeline replies but that's pretty time-consuming for users like me.

My suggestion is that the changelog and/or release notes for that release should say "handle errors in multi/pipeline replies" since that is what has really happened.

leibale commented 9 months ago

If you scroll a bit more in the releases page you can see client@1.5.13 release, which lists what changed https://github.com/redis/node-redis/releases/tag/client%401.5.13

Its not the best, but I think that you've missed it..