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

Make the Changelog an actual change log #1006

Open
atleta opened this issue Nov 24, 2022 · 1 comment
Open

Make the Changelog an actual change log #1006

atleta opened this issue Nov 24, 2022 · 1 comment
Assignees

Comments

@atleta
Copy link

atleta commented Nov 24, 2022

It seems that you keep overwriting the ChangeLog file/deleting the old content and only keep the latest changes so the only way to actually look at the change log is to dig its commit history. However the very purpose of a change log file would be to show the history of changes.

E.g. the current Changelog file only shows what's new for 3.0.x, but that only works with Django 4.0 so whoever still using Grappelli 2.x won't see anything informative there. And this includes those who plan to upgrade to 3.x (not even 3.0 is included in the Changelog file), which I guess is a larger changeset.

The idea behind a change log file is to be able to find the version I use and then be able to look at all the improvements over time. Please consider merging the individual versions from the git history and keeping a continuous log from this point on.

@sehmaschine sehmaschine self-assigned this Nov 25, 2022
@sehmaschine
Copy link
Owner

Good points, but ...

The reason behind this is that I'm not sure how to handle 2 (or more) simultaneous releases which have a different changelogs ... how would you solve this? E.g., if we update 2.15.x ... that cannot go into the changelog of 3.0.x, right?

E.g. the current Changelog file only shows what's new for 3.0.x, but that only works with Django 4.0 so whoever still using Grappelli 2.x won't see anything informative there.

Why should someone who is using Django 3.2 (for example) check the changelog of Grappelli 3.0 (which is not compatible with that version)?

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