Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Fix typos in release script docs #12450

Merged
merged 2 commits into from
Apr 12, 2022
Merged

Fix typos in release script docs #12450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19bd3fe
Fix typos in release script docs
erikjohnston Apr 12, 2022
fe531e5
Newsfile
erikjohnston Apr 12, 2022
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
1 change: 1 addition & 0 deletions changelog.d/12450.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix typo in the release script help string.
3 changes: 2 additions & 1 deletion scripts-dev/release.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,12 @@ def cli():
# ... wait for assets to build ...

./scripts-dev/release.py publish

Copy link
Member Author

Choose a reason for hiding this comment

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

This newline is needed, annoyingly, as otherwise it renders the two commands on a single line

Copy link
Contributor

Choose a reason for hiding this comment

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

I think \b can be reused to disable this; see https://click.palletsprojects.com/en/8.1.x/documentation/#preventing-rewrapping

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh fun, TIL.

./scripts-dev/release.py upload

# Optional: generate some nice links for the announcement

./scripts-dev/release.py upload
./scripts-dev/release.py announce
Copy link
Contributor

Choose a reason for hiding this comment

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

oops. thanks.


If the env var GH_TOKEN (or GITHUB_TOKEN) is set, or passed into the
`tag`/`publish` command, then a new draft release will be created/published.
Expand Down