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

Pause in prepare-release for updating the NEWS file #12764

Merged
merged 1 commit into from
Jun 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,11 @@ def prepare_release(session: nox.Session) -> None:

session.log("# Generating NEWS")
release.generate_news(session, version)
if sys.stdin.isatty():
input(
"Please review the NEWS file, make necessary edits, and stage them.\n"
Copy link
Member

Choose a reason for hiding this comment

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

How about

Suggested change
"Please review the NEWS file, make necessary edits, and stage them.\n"
"Please review the NEWS file, make necessary edits, and stage them (`git add NEWS.rst`).\n"

?

Or the script could even run it unconditionally in this branch..

Copy link
Member Author

Choose a reason for hiding this comment

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

Or the script could even run it unconditionally in this branch..

Let's do this in a follow up!

"Press Enter to continue..."
)

session.log(f"# Bumping for release {version}")
release.update_version_file(version, VERSION_FILE)
Expand Down
Loading