search

unlock-protocol / unlock

Ʉnlock is a protocol for memberships built on a blockchain.
https://unlock-protocol.com
MIT License
845 stars 252 forks source link

Add Changelog to npm packages #10765

Open mankins opened 1 year ago

mankins commented 1 year ago

Is your feature request related to a problem? Please describe.

It would be nice to add a changelog associated with npm package releases.

In particular it would be nice to validate that packages adhere to semver as suggested in https://github.com/unlock-protocol/unlock/issues/10267

Describe the solution you'd like

Keep a Changelog offers some best practices for this.

Ideally version numbers are meaningful and if there's a breaking change in the underlying contracts, then the semver shows it. This will help maintainers know that either new code needs to be written, or extra testing is required before updating.

Describe alternatives you've considered If releases happen via CI, I'd be happy to have the git log appended to the changelog as being better than nothing.

Additional context

A maintainer of some of our code that includes unlock sent this message:


 @unlock-protocol/contracts  ^0.0.9  →  ^0.0.16
julien51 commented 1 year ago

I wonder if we could use a tool like this https://www.npmjs.com/package/auto-changelog ?

mankins commented 1 year ago

I've used np before and it helped. Still some manual buttons to press, but that allowed editing.