Skip to content

Add automatically generated change log file.#465

Merged
johnhaley81 merged 1 commit intonodegit:masterfrom
skywinder:add-change-log-file
Apr 18, 2015
Merged

Add automatically generated change log file.#465
johnhaley81 merged 1 commit intonodegit:masterfrom
skywinder:add-change-log-file

Conversation

@skywinder
Copy link
Copy Markdown
Contributor

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_generator in your repo folder.
Hope you find this commit as useful.

@johnhaley81
Copy link
Copy Markdown
Collaborator

Any objections to this @nodegit/owners?

@maxkorp
Copy link
Copy Markdown
Collaborator

maxkorp commented Mar 5, 2015

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).

@skywinder
Copy link
Copy Markdown
Contributor Author

@maxkorp thanks for mention it.
It will be a nice feature: to not include PR's, that fix closes another issues. I will research, how to implement it.

About excluding issues: this script can exclude/include issues by specific labels.

@maxkorp
Copy link
Copy Markdown
Collaborator

maxkorp commented Mar 6, 2015

Interesting! That would be great, since we could exclude issues fixed that were introduced in the same release

@skywinder
Copy link
Copy Markdown
Contributor Author

@maxkorp so, what your opinion: is it better to exclude PR's or issues, that closed by PR from change log?

@tbranyen
Copy link
Copy Markdown
Member

@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>

@skywinder
Copy link
Copy Markdown
Contributor Author

@tbranyen What do you mean? What should be in place of "some_gh_changelog"?
Now every tag name - is a link to this tag in project:
For example tag 0.2.4 links to https://github.com/nodegit/nodegit/tree/v0.2.4

@tbranyen
Copy link
Copy Markdown
Member

We've brought this into our site, should we maintain a file in this repo as well?

@skywinder
Copy link
Copy Markdown
Contributor Author

@tbranyen
If you want to refer to specific tag in changelog (e.g. Add Anchor Tags To Jump To Specific Location On A Changelog), you can click on the chain image close with tag name:
screen shot 2015-03-17 at 13 17 19

And the browser will redirect you to the link with this tag as anchor:
( https://github.com/skywinder/nodegit/blob/add-change-log-file/CHANGELOG.md#v026-2015-01-20 in that case)
Is it a option, that you are looking for?

@maxkorp
Copy link
Copy Markdown
Collaborator

maxkorp commented Mar 18, 2015

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.

@skywinder
Copy link
Copy Markdown
Contributor Author

But now your history has only one tag.
I decide to take this name, because it's kind of standart. ( keepachangelog.com )

But you can specify your custom name for output file:

github_changelog_generator -o HISTORY.md

@maxkorp
Copy link
Copy Markdown
Collaborator

maxkorp commented Mar 19, 2015

Yeah, I was saying keep this, and append the contents of history to this ;)

@johnhaley81
Copy link
Copy Markdown
Collaborator

👍

@johnhaley81
Copy link
Copy Markdown
Collaborator

@nodegit/owners how do you guys feel about merging this?

@tbranyen
Copy link
Copy Markdown
Member

Yeah might as well. We can always change it later. Something is better than nothing.

johnhaley81 added a commit that referenced this pull request Apr 18, 2015
Add automatically generated change log file.
@johnhaley81 johnhaley81 merged commit 12a2b60 into nodegit:master Apr 18, 2015
@skywinder
Copy link
Copy Markdown
Contributor Author

Hooray, guys! 👍
BDW, I will add one feature soon: github-changelog-generator/github-changelog-generator#54
Since you are use quite different labels, rather than default github labels (Bug - bug, Modification- enhancement, Question - question) - this feature will help to make change log even more organised! I'll let you know when I'm done with it!

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.

4 participants