Update Release guide to current practices #25023
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
QuLogic
force-pushed
the
release-guide
branch
from
49a78c0 to
230a2f8
Compare
tacaswell
approved these changes
Jan 18, 2023
QuLogic
force-pushed
the
release-guide
branch
from
230a2f8 to
c5fe1d6
Compare
story645
reviewed
Jan 18, 2023
doc/devel/release_guide.rst
Outdated
Comment on lines
44
to
46
| 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.
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.
There is an implied 'while' before the 'changing'.
QuLogic
force-pushed
the
release-guide
branch
from
c5fe1d6 to
13dd58e
Compare
story645
approved these changes
Jan 19, 2023
Merged
|
Note for later: add instruction to check spelling in GitHub stats, re #25084 |
This clears up the flake8 exception, and corrects the title and trailing whitespace that I always need to clean up when committing the file.
Every run of the script adds an extra newline at the end.
ksunden
force-pushed
the
release-guide
branch
from
13dd58e to
9d5837f
Compare
|
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) |
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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