search

neo4j / neo4j-javascript-driver

Neo4j Bolt driver for JavaScript
https://neo4j.com/docs/javascript-manual/current/
Apache License 2.0
853 stars 148 forks source link

Add release notes to Github releases #1165

Closed ryan-dahlia closed 8 months ago

ryan-dahlia commented 9 months ago

Feature Request

Thank you for this great library! Please consider making your release notes available to Dependabot, so that users can more easily understand the changes for each version update.

I believe it would be sufficient to move your CHANGELOG file to the root of the repo, and/or add release notes in the Github Releases section.

Pitch

The maintainers do a great job documenting the changes between versions, but Dependabot cannot source them, because they are in a non-standard location. Therefore, Dependabot shows the generic message from the Releases page, instead of the full release notes (see photo).

image
bigmontz commented 9 months ago

This is a fair point, I will check it out how to do it without duplicate work.

ryan-dahlia commented 9 months ago

Great, thank you @bigmontz! I'm not a Dependabot expert but lmk if I can help!

ryan-dahlia commented 8 months ago

@bigmontz thank you for incorporating this suggestion, it looks lovely!

image