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

Advance logic for --base option #269

Open
skywinder opened this issue Aug 25, 2015 · 3 comments
Open

Advance logic for --base option #269

skywinder opened this issue Aug 25, 2015 · 3 comments

Comments

@skywinder
Copy link
Member

It's addition for #258.

For now --base option just concat old change log with new, auto-generated.
It would be nice to use full power of Reader, to not just fetch last tag, but also fetch content for each issue and put auto-generated section for each tag, and then data from content.

For example, for https://github.com/troessner/reek project

For tag 3.3.0:

Form manual change log:

3.3.0 (2015-08-23)

  • (HParker / Adam Hess) add support for or-assign constants
  • (troessner) Update TooManyMethods default value to 15

For auto-generated change log:

v3.3.0 (2015-08-22)

Full Changelog
Fixed bugs:

  • Rake release doesn't work anymore with latest bundler #643
  • Rake task blows up with ‘Error: No such file - lib/**/*.rb’ #642
  • Make AppConfiguration's initializer flexible enough to deal with different inputs #608
    Closed issues:
  • private method `load' called for Psych:Module #653
    Merged pull requests:
  • Remove spec/gem directory. #659 (troessner)
  • Ensure each file can be individually required #658 (mvz)
  • etc...

In the end, I want to get something like this as output:

v3.3.0 (2015-08-22)

Full Changelog

  • (HParker / Adam Hess) add support for or-assign constants
  • (troessner) Update TooManyMethods default value to 15

[//]: # (START OF AUTO CHANGE LOG CONTENT)

Fixed bugs:

  • Rake release doesn't work anymore with latest bundler #643
  • Rake task blows up with ‘Error: No such file - lib/**/*.rb’ #642
  • Make AppConfiguration's initializer flexible enough to deal with different inputs #608

Closed issues:

  • private method `load' called for Psych:Module #653

Merged pull requests:

  • Remove spec/gem directory. #659 (troessner)
  • Ensure each file can be individually required #658 (mvz)
  • etc...

The string [//]: # (START OF AUTO CHANGE LOG CONTENT) will be invisible in markdown file, but helps to detect where manual change log ends (could be helpful in the future).

@raphink
Copy link
Collaborator

raphink commented Aug 25, 2015

So you would use a merge approach. That could be really cool, as it would allow to store all manual entries aside, with just the tag for each, and let the automated part populate from GitHub + date.

@skywinder
Copy link
Member Author

Yep. And your PR #258 was a good movement in that direction. I will handle it soon.

@fabn
Copy link

fabn commented Dec 15, 2015

I've just discovered this project and already love it.

This issue (and possibly #56) is the number one issue in my watchlist.

Not every notable change is documented in GH issues so have a way to add manual entries to changelog file imho is a must.

That said thanks for this awesome gem.

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

No branches or pull requests

3 participants