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

Changelog for 7.x missing #101

Open
kelunik opened this issue Jul 13, 2016 · 3 comments
Open

Changelog for 7.x missing #101

kelunik opened this issue Jul 13, 2016 · 3 comments

Comments

@kelunik
Copy link
Contributor

kelunik commented Jul 13, 2016

All changes since 7.0.0 are missing in the changelog.

@odino
Copy link
Contributor

odino commented Jul 14, 2016

hey @kelunik thanks for reporting!

To be fair I really think the commit history should give us the changelog we're looking for, rather than a manual one that easily gets out of sync with the changes in git -- unfortunately docs are always bound to get stale :(

Im planning to remove the changelog from the README if no one has anything against

@kelunik
Copy link
Contributor Author

kelunik commented Jul 14, 2016

git tag
git show 6.1.1
git log --oneline --reverse --no-merges d234ab5da058bda234efbfc231a4ff68f9c984be..HEAD

That gives a fine commit overview for 6.1.1 to master / HEAD, but I don't know what changed in which version. Are there changes that require an update from 6.x? Any security issues?

Things like that are usually not answered by a commit log. Additionally, many commit messages are rather poor compared to a well maintained CHANGELOG.md.

Maintaining docs is a lot harder than a CHANGELOG.md. If you often forget about it, don't use a CHANGELOG.md but GitHub Release Notes at least. That's what I do myself, see https://github.com/kelunik/acme-client/releases for an example.

If you tag a new version, put the changes right into the tag annotation. Publish a new release on GitHub. The release on GitHub can have the same text body as the tag annotation. That was it's easy not to forget it.

I strongly object to not having changes listed at all.

@odino
Copy link
Contributor

odino commented Jul 16, 2016

The truth is that as much as what you describe is ideal I think time is the factor that wont let us have a very eloquent changelog from time to time :) Would be happy if someone can send a PR to the README for that!

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