search

cabal-club / cabal-core

Core database and replication for cabal.
GNU Affero General Public License v3.0
302 stars 43 forks source link

keep a changelog #63

Open hackergrrl opened 4 years ago

hackergrrl commented 4 years ago

I think it could be very useful to downstream consumers if this module published a changelog[1]. It'd be nice to be able to get a high-level understanding of what is changing between minor and especially major versions.

[1] https://keepachangelog.com/en/1.0.0/

cblgh commented 4 years ago

+1 l think we should do this by using a notation in git commits that, when parsed, will take the rest of the commit message as the description for the change. with identifying parts for added/removed/changed

and then generate the logs on npm version {major,minor,patch} based on the commit history

On Thu, 21 Nov 2019 at 00:00, noffle notifications@github.com wrote:

I think it could be very useful to downstream consumers if this module published a changelog[1]. It'd be nice to be able to get a high-level understanding of what is changing between minor and especially major versions.

[1] https://keepachangelog.com/en/1.0.0/

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/cabal-club/cabal-core/issues/63?email_source=notifications&email_token=AA5O6WUCJUW6WILWEI5QWETQUW6STA5CNFSM4JP2PB22YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4H26E76Q, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA5O6WQWDGHWFZYZT2ASY5LQUW6STANCNFSM4JP2PB2Q .

okdistribute commented 4 years ago

gregor uses this and it seems to work well for generating the CHANGELOG from commit history! https://www.npmjs.com/package/standard-version