spyder-ide/loghub

Add user to rendered changelog

pydanny opened this issue · 8 comments

Concept:

###############################################################################

Version <RELEASE_VERSION> (2018/02/24)

Pull Requests Merged

In this release 1 pull request was closed.

###############################################################################

Having this feature added would be very useful for the Cookiecutter community.

@pydanny I like it :-), pretty straight forward to add :-)

@djhoese what do you think of this?

@goanpeca @pydanny Does using the @ make every new release notify an author (either in a github release or as a commit of a changelog file)? Before switching to loghub I had been using gitchangelog which uses brackets [David Hoese] as opposed to the username. Might also look better than seeing , by X after every PR. Since it is possible to change your username maybe it would be better to use the accounts name? Just ideas, not necessarily thinking it needs changing. Regardless someone can customize their template if they want once the information is made available.

I do not think that github will notify users about @username being used on a markdown file within the repo. If that was the case then

[username] could be used, since not everyone provides a "real name", so usernames are better.

Thoughts @pydanny @ccordoba12 ?

For what it's worth the github changelog generator project does usernames in markdown by doing:

[djhoese](https://github.com/djhoese)

https://github.com/github-changelog-generator/github-changelog-generator

Ok, much better :-) will add that one

So something like this:

image