Skip to content

Commit

Permalink
Test github token before running release script (#17562)
Browse files Browse the repository at this point in the history
This stops people from getting half way through a step and it failing
due to the github token having expired (this happens to me every damn
time).
  • Loading branch information
erikjohnston authored Aug 19, 2024
1 parent f162c92 commit a5d25bb
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/17562.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Test github token before running release script steps.
25 changes: 25 additions & 0 deletions scripts-dev/release.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,11 @@ def tag(gh_token: Optional[str]) -> None:
def _tag(gh_token: Optional[str]) -> None:
"""Tags the release and generates a draft GitHub release"""

if gh_token:
# Test that the GH Token is valid before continuing.
gh = Github(gh_token)
gh.get_user()

# Make sure we're in a git repo.
repo = get_repo_and_check_clean_checkout()

Expand Down Expand Up @@ -418,6 +423,11 @@ def publish(gh_token: str) -> None:
def _publish(gh_token: str) -> None:
"""Publish release on GitHub."""

if gh_token:
# Test that the GH Token is valid before continuing.
gh = Github(gh_token)
gh.get_user()

# Make sure we're in a git repo.
get_repo_and_check_clean_checkout()

Expand Down Expand Up @@ -460,6 +470,11 @@ def upload(gh_token: Optional[str]) -> None:
def _upload(gh_token: Optional[str]) -> None:
"""Upload release to pypi."""

if gh_token:
# Test that the GH Token is valid before continuing.
gh = Github(gh_token)
gh.get_user()

current_version = get_package_version()
tag_name = f"v{current_version}"

Expand Down Expand Up @@ -555,6 +570,11 @@ def wait_for_actions(gh_token: Optional[str]) -> None:


def _wait_for_actions(gh_token: Optional[str]) -> None:
if gh_token:
# Test that the GH Token is valid before continuing.
gh = Github(gh_token)
gh.get_user()

# Find out the version and tag name.
current_version = get_package_version()
tag_name = f"v{current_version}"
Expand Down Expand Up @@ -711,6 +731,11 @@ def _announce() -> None:
@cli.command()
@click.option("--gh-token", envvar=["GH_TOKEN", "GITHUB_TOKEN"], required=True)
def full(gh_token: str) -> None:
if gh_token:
# Test that the GH Token is valid before continuing.
gh = Github(gh_token)
gh.get_user()

click.echo("1. If this is a security release, read the security wiki page.")
click.echo("2. Check for any release blockers before proceeding.")
click.echo(" https://github.com/element-hq/synapse/labels/X-Release-Blocker")
Expand Down

0 comments on commit a5d25bb

Please sign in to comment.