nvm-sh / nvm

Node Version Manager - POSIX-compliant bash script to manage multiple active node.js versions
MIT License
80.6k stars 8.04k forks source link

Add Changelog #607

Open michaelgilley opened 9 years ago

michaelgilley commented 9 years ago

Hey, first off thank you so much for the amazing tool! It's proven to be indispensable for me and my team.

I know it's been mentioned that plans are to add an automatic changelog generator but I thought I'd add an official request here. A changelog (CHANGELOG.md) would really be helpful in updating my nvm's so I didn't need to read commit messages.

ljharb commented 9 years ago

The releases page https://github.com/creationix/nvm/releases has some change log notes.

As part of the https://github.com/creationix/nvm/milestones/v1.0.0 release, I intend to start keeping a CHANGELOG.

NKjoep commented 5 years ago

Hi! Do you think we could use the gren utility to generate the changelog? github-release-notes

~It doesn't look perfect, however it has options to group together labels/tags given some keywords.~

So actually, with these settings I got an accurate changelog file :)

{
  "data-source": "milestones",
  "milestone-match": "{{tag_name}}",
  "only-milestones": true,
  "changelogFilename": "CHANGELOG.md"
}

Here an example of the actual output with those options provided:

Generated CHANGELOG.md

NKjoep commented 5 years ago

@ljharb let me know if I should open a PR with this 🙌

ljharb commented 5 years ago

@NKjoep i'd want the changelog to be part of the tagged release commit.