Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Update Release guide to current practices#25023
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
modulo waiting for the line length to be relaxed.
doc/devel/release_guide.rst Outdated
| API. Copy the current :file:`doc/users/github_stats.rst` to | ||
| :file:`doc/users/prev_whats_new/github_stats_{X}.{Y}.{Z}.rst`, changing the link target | ||
| at the top of the file, and removing the "Previous GitHub Stats" section at the end. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Any chance this can be changed to a numbered list of steps? And the tenses here confuse me - does copying auto change things or do they need to be changed manually?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
There is an implied 'while' before the 'changing'.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Can it be explicit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Sure
Note for later: add instruction to check spelling in GitHub stats, re#25084 |
This clears up the flake8 exception, and corrects the title and trailingwhitespace that I always need to clean up when committing the file.
Every run of the script adds an extra newline at the end.
Rebased and fixed the one remaining flake8 error (docstring in Should be good to merge upon CI passing. (Was waiting for the line length bump) |
Uh oh!
There was an error while loading.Please reload this page.
PR Summary
This updates the release guide to follow what I currently do. It also updates the helper scripts to clean up some minor whitespace issues that I always need to fix before committing.
Note that this is wrapped at 88, so may have to wait for PR#24893 to go in.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst