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

Get ready for release 7.0.0 #1063

Merged
merged 1 commit into from
Aug 9, 2024
Merged

Get ready for release 7.0.0 #1063

merged 1 commit into from
Aug 9, 2024

Conversation

rocky
Copy link
Member

@rocky rocky commented Aug 9, 2024

Go over release notes. Add a way to correct spelling mistakes in ChangeLog produced (which is used to create CHANGES.rst)

@rocky rocky requested a review from mmatera August 9, 2024 15:04
@@ -0,0 +1,3526 @@
--- ChangeLog 2024-08-09 10:10:09.519394315 -0400
+++ ChangeLog-spell-corrected 2024-08-09 10:08:54.403769916 -0400
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand why we want to versioning this diff file.

Copy link
Member Author

@rocky rocky Aug 9, 2024

Choose a reason for hiding this comment

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

ChangeLog is recreated from the commit history with spelling mistakes. Those mistakes are fixed by the diff.

The diff saves me from having manually make the same spelling (and other) corrections to the recreated ChangeLog. Over time this will of course grow as new changes and spelling mistakes are made.

And if I kept this private, then others would not benefit from the corrections.

Ideally one would go back into git and fix the commit messages. But that is not easy since the SHA is based on the commit message and time I think.

Copy link
Contributor

@mmatera mmatera left a comment

Choose a reason for hiding this comment

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

LGTM

@mmatera
Copy link
Contributor

mmatera commented Aug 9, 2024

Go over release notes. Add a way to correct spelling mistakes in ChangeLog produced (which is used to create CHANGES.rst)

Would not be enough to pick the ChangeLog since the last release and keep CHANGES.rst clean of typos?

@rocky rocky merged commit 751cc98 into master Aug 9, 2024
10 checks passed
@rocky rocky deleted the release-7.0.0 branch August 9, 2024 15:55
@rocky
Copy link
Member Author

rocky commented Aug 9, 2024

Go over release notes. Add a way to correct spelling mistakes in ChangeLog produced (which is used to create CHANGES.rst)

Would not be enough to pick the ChangeLog since the last release and keep CHANGES.rst clean of typos?

The ChangeLog goes into the distribution. It provide a slightly more detailed and slightly cleaned up version of the actual commit changes.

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

Successfully merging this pull request may close these issues.

2 participants