Skip to content

Skip installer tasks for security releases #446

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.

Sign up for GitHub

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

Open
hugovk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Skip installer tasks for security releases #446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions run_release.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -955,6 +955,12 @@ def start_build_release(db: ReleaseShelf) -> None:


def start_windows_build(db: ReleaseShelf) -> None:
# Security releases are source-only: no installers are built for Windows
# or macOS, so there is no Windows build to start.
if db["security_release"]:
print("Skipping: security releases are source-only, no Windows build needed")
return

commit_sha = get_commit_sha(db["release"].gitname, db["git_repo"])
origin_remote_url = get_origin_remote_url(db["git_repo"])
origin_remote_github_owner = extract_github_owner(origin_remote_url)
Expand Down Expand Up @@ -988,6 +994,15 @@ def start_windows_build(db: ReleaseShelf) -> None:


def send_email_to_platform_release_managers(db: ReleaseShelf) -> None:
# Security releases are source-only: no installers are built for Windows
# or macOS, so the platform release managers don't need the commit SHA.
if db["security_release"]:
print(
"Skipping: security releases are source-only, "
"no platform release managers to notify"
)
return

commit_sha = get_commit_sha(db["release"].gitname, db["git_repo"])
origin_remote_url = get_origin_remote_url(db["git_repo"])
origin_remote_github_owner = extract_github_owner(origin_remote_url)
Expand Down
24 changes: 24 additions & 0 deletions tests/test_run_release.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,3 +258,27 @@ def test_update_whatsnew_toctree(tmp_path: Path) -> None:
# Assert
new_contents = toctree__file.read_text()
assert " 3.15.rst\n 3.14.rst\n" in new_contents


@pytest.mark.parametrize(
"task",
[
run_release.start_windows_build,
run_release.send_email_to_platform_release_managers,
],
)
def test_skip_platform_tasks_for_security_release(
task: Any, capsys: pytest.CaptureFixture[str]
) -> None:
# Arrange
# No git_repo in db: the task must return before touching the repo
db = {
"release": Tag("3.13.12"),
"security_release": True,
}

# Act
task(cast(ReleaseShelf, db))

# Assert
assert "Skipping: security releases are source-only" in capsys.readouterr().out
Loading