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

Set up automatic changelog #192

Open
Almad opened this issue Dec 29, 2017 · 2 comments
Open

Set up automatic changelog #192

Almad opened this issue Dec 29, 2017 · 2 comments
Projects

Comments

@Almad
Copy link
Member

Almad commented Dec 29, 2017

The manual changelog is error prone and also contributes to procastinating on releases.

I have good experiences with semantic-release from JS world, so unless someone has better suggestions, I will set up something like https://github.com/relekang/python-semantic-release

@Almad Almad added this to To Do in Paver 1.4 via automation Dec 29, 2017
@craigds
Copy link

craigds commented Aug 24, 2018

As a recommendation, don't try to have a full changelog. Do 'upgrade notes' or something. Be meticulous about including any breaking changes, but that's mostly all you need.

The main thing I (and I suspect a lot of people) use changelogs for is to answer the question: is it safe to update to the new version? A changelog that literally only lists breaking changes is very easy to maintain.

@Almad
Copy link
Member Author

Almad commented Sep 15, 2018

Good point. I am maintaining full changelog given that's how it was done before in the project, but breaking changes are probably more readable for everyone :) (for everyone else, there is git log)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Paver 1.4
  
To Do
Development

No branches or pull requests

2 participants