Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create changelog based on pull requests #426

Merged
merged 2 commits into from Feb 25, 2014

Conversation

lalitkapoor
Copy link
Contributor

I saw that you have a changelog on your site and thought you might find the following useful. It's a tool that generates a changelog based on merged pull requests (with some additional benefits - accreditation, linking to the issue, and automation).

you can find the tool here https://github.com/lalitkapoor/github-changes.

To install it:
npm install -g github-changes

This was the command used to generate the changelog for dustjs:
github-changes -o linkedin -r dustjs -d pulls -a -v

Please let me know If you need any help adding it to your release script. If there are any improvements you'd like to see in this tool please feel free to open an issue :) Thanks!

@prashn64
Copy link
Contributor

This looks really good. Do people agree we can remove the need for the "linkedin additions" to this page:

http://linkedin.github.io/dustjs/

and then add this is a grunt task to the releases?

@kate2753
Copy link
Contributor

I like the idea of integrating with grunt @prashn64 and removing that section from linkedin.gihutb.io. Less work and don't have to remember to keep it up to date.

I would love to see releases ordered by version number, not by the date they were released.
We've released few patches to 2.2.x recently and change log seems a bit confusing to me where 2.2.6 was the last release instead of 2.3.3

@lalitkapoor
Copy link
Contributor Author

@kate2753 ah, you're right. I'll look into fixing that. Thanks for taking a look!

@jimmyhchan
Copy link
Contributor

How stable is this? Any other repo using this? Can we pull in a grunt task
that wraps this instead?

It's just a dev dependency so not too big a deal big and very much better
then what we have now

@lalitkapoor
Copy link
Contributor Author

@jimmyhchan it's not stable yet. I'm using this in a few places myself - most notable, currently, would be mikeal's request library - https://github.com/mikeal/request

I'm happy to actively maintain any code surround it here as I get the tool to a stable version.

Currently working on addressing the issue @kate2753 brought up. Will have a fix in soon.

@lalitkapoor
Copy link
Contributor Author

ready for review.

new command (v0.0.8):
github-changes -o linkedin -r dustjs -a --only-pulls --use-commit-body --order-semver -v

@prashn64
Copy link
Contributor

looks good

kate2753 added a commit that referenced this pull request Feb 25, 2014
@kate2753 kate2753 merged commit 38fe421 into linkedin:master Feb 25, 2014
@lalitkapoor lalitkapoor deleted the changelog branch February 25, 2014 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants