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

[post] Allow the append (not overwrite) CHANGELOG generation mode #66

Open
vovacodes opened this issue Feb 6, 2017 · 4 comments
Open

Comments

@vovacodes
Copy link

Say I have an old CHANGELOG in the package and I would like to preserve its content whilst being able to use lerna-semantic-release post to append new entries there.

We could check conventional-changelog-cli for inspiration, they have this functionality implemented

@vovacodes vovacodes changed the title [post] Allow to append (not overwrite) CHANGELOG generation mode [post] Allow the append (not overwrite) CHANGELOG generation mode Feb 6, 2017
@vovacodes
Copy link
Author

seems like we only need to allow to override this parameter through a CLI flag

@jpnelson
Copy link

I was thinking about this – one nice thing about regenerating every time is that we can fix up changelog generation as we go – if the format of the log is incorrect, we can change the formatter and the changelogs will get updated.

Maybe a nice alternative would be to let git notes show in the changelog? That way we'd have a way of appending to changelogs after the fact, and still associate the notes with specific commits. You'd get to keep the benefits of regenerating every time.

Maybe this idea should make it back to conventional-changelog-cli for us to consume, somehow

@vovacodes
Copy link
Author

vovacodes commented Feb 10, 2017

Maybe a nice alternative would be to let git notes show in the changelog?

Could you please explain in more detail what git notes you mean and how it would work?

one nice thing about regenerating every time is that we can fix up changelog generation as we go

I'm totally for it to be a default behavior, but I would simply allow adjusting the defaults with a flag, so that for those who don't want to add any "extra" changelog processing there will be an option to keep the old entries intact.

@vovacodes
Copy link
Author

I have started progressing on this

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

2 participants