Add automatically generated change log file.#465
Conversation
|
Any objections to this @nodegit/owners? |
|
Hrm, I like that a lot for incrementals, not sure on the big update like this one. many of those PRs are fixing things introduced in the release, so it seems odd to include them in the changelog. At minimum, that is an awesome starting point, and potentially an all around solution in many cases (dot releases etc). Awesome awesome tool. The only other thought is that currently we have history.md, this should be prepended there, either instead of included here, or in addition to (I'm not opposed to having a changelog for the latest version separate from the history). |
|
@maxkorp thanks for mention it. About excluding issues: this script can exclude/include issues by specific labels. |
|
Interesting! That would be great, since we could exclude issues fixed that were introduced in the same release |
|
@maxkorp so, what your opinion: is it better to exclude PR's or issues, that closed by PR from change log? |
|
@skywinder can you also add a useful hash name to the header anchors? Something like <a name="v0-0-6" href="some_gh_changelog">v0.0.6</a> |
|
@tbranyen What do you mean? What should be in place of "some_gh_changelog"? |
|
We've brought this into our site, should we maintain a file in this repo as well? |
|
@tbranyen And the browser will redirect you to the link with this tag as anchor: |
|
I think it's sort of customary to include the changelog with the source, yeah. We already have HISTORY.md but we can rename it and append it to this. |
|
But now your history has only one tag. But you can specify your custom name for output file: |
|
Yeah, I was saying keep this, and append the contents of history to this ;) |
|
👍 |
|
@nodegit/owners how do you guys feel about merging this? |
|
Yeah might as well. We can always change it later. Something is better than nothing. |
Add automatically generated change log file.
|
Hooray, guys! 👍 |

Hi, as I can see, you are carefully fill tags and labels for issues in your repo.
I created a github_changelog_generator, that generate change log file based on tags, issues and merged pull requests (and split them to separate lists according labels) from GitHub issue tracker.
This Change Log was automatically generated by this script.
It helps to easily found what and when was fixed and implemented.
You can easily update this file in future by running script:
github_changelog_generatorin your repo folder.Hope you find this commit as useful.