Skip to content

[DOCS] Integrate the 8.x changelog into the main changelog #806

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

Merged
merged 3 commits into from
Jan 27, 2025

Conversation

oliverklee
Copy link
Collaborator

Now the changelog up to the latest feature release 8.7.0 is part of the main changelog.

This makes it easier to see what has changed after the last feature release.

Also, this makes it clear in which release some methods were deprecated, avoid the impression that methods got both deprecated and removed in the same release.

Also autoformat the changelog.

@coveralls
Copy link

coveralls commented Jan 25, 2025

Coverage Status

coverage: 51.041%. remained the same
when pulling f557cf8 on docs/8-changelog-in-main
into 98e4204 on main.

@oliverklee oliverklee force-pushed the docs/8-changelog-in-main branch from f7a8227 to 3c1b281 Compare January 25, 2025 20:44
Copy link
Collaborator

@JakeQZ JakeQZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the 8.x changelog entries reference backport PRs, whereas some reference the equivalent change on main.

I think they should be all one or all the other. I'm leaning towards referencing the changes on main, and have identified the equivalents.

Either way, it would mean the changelog no longer exactly matching the release notes (with some different, but equivalent PRs being referenced). If it's important for the changelog to match the release notes, then the mishmash of referenced PRs can be retained...

@oliverklee oliverklee force-pushed the docs/8-changelog-in-main branch from 3c1b281 to 98b430c Compare January 26, 2025 10:32
@oliverklee
Copy link
Collaborator Author

I think they should be all one or all the other. I'm leaning towards referencing the changes on main, and have identified the equivalents.

Thanks! Yes, that makes sense.

@oliverklee

This comment was marked as outdated.

@oliverklee oliverklee marked this pull request as draft January 26, 2025 15:49
@oliverklee oliverklee removed the request for review from sabberworm January 26, 2025 15:49
Copy link
Collaborator

@JakeQZ JakeQZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found one typo. Everything else looks fine now.

@oliverklee oliverklee force-pushed the docs/8-changelog-in-main branch from 09c3a92 to 4108220 Compare January 27, 2025 08:27
@oliverklee oliverklee requested a review from JakeQZ January 27, 2025 08:27
@oliverklee
Copy link
Collaborator Author

Rebased and updated.

@oliverklee oliverklee force-pushed the docs/8-changelog-in-main branch from 4108220 to 18cd6f4 Compare January 27, 2025 08:39
@JakeQZ
Copy link
Collaborator

JakeQZ commented Jan 27, 2025

Rebased and updated.

Is this ready for review now - it's still marked as draft?

@oliverklee oliverklee marked this pull request as ready for review January 27, 2025 16:15
@oliverklee
Copy link
Collaborator Author

Oh, sorry, forgot that. Yes, it's ready for review now.

oliverklee and others added 3 commits January 27, 2025 18:45
Now the changelog up to the latest feature release 8.7.0 is
part of the `main` changelog.

This makes it easier to see what has changed after the last
feature release.

Also, this makes it clear in which release some methods were
deprecated, avoid the impression that methods got both
deprecated and removed in the same release.

Also autoformat the changelog.
Co-authored-by: JakeQZ <jake@qzdesign.co.uk>
@oliverklee oliverklee force-pushed the docs/8-changelog-in-main branch from 18cd6f4 to f557cf8 Compare January 27, 2025 17:45
@JakeQZ JakeQZ merged commit 9f5c7dc into main Jan 27, 2025
21 checks passed
@JakeQZ JakeQZ deleted the docs/8-changelog-in-main branch January 27, 2025 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants