Skip to content

Replace release.py with OIDC publishing #8483

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

Merged
merged 1 commit into from
Mar 11, 2023
Merged
Show file tree
Hide file tree
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
67 changes: 67 additions & 0 deletions .github/workflows/pypi-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Publish to PyPI

on:
workflow_dispatch:
inputs:
run_id:
description: The run of wheel-builder to use for finding artifacts.
required: true
environment:
description: Which PyPI environment to upload to
required: true
type: choice
options: ["pypi", "testpypi"]
# Disabled until this has been validated with `workflow_dispatch` + Test PyPI.
# workflow_run:
# workflows: ["wheel-builder.yml"]
# types: [completed]

jobs:
publish:
runs-on: ubuntu-latest
# We're not actually verifying that the triggering push event was for a
# tag, because github doesn't expose enough information to do so.
# wheel-builder.yml currently only has push events for tags.
if: github.event_name == 'workflow_dispatch' || (github.event.workflow_run.event == 'push' && github.event.workflow_run.conclusion == 'success')
permissions:
id-token: "write"
steps:
- uses: dawidd6/action-download-artifact@5e780fc7bbd0cac69fc73271ed86edf5dcb72d67
with:
path: dist/
run_id: ${{ github.event.inputs.run_id || github.event.workflow_run.event.id }}
- run: pip install -c ci-constraints-requirements.txt twine requests

- run: |
echo "OIDC_AUDIENCE=pypi" >> GITHUB_ENV
echo "PYPI_DOMAIN=pypi.org" >> GITHUB_ENV
echo "TWINE_REPO=pypi" >> GITHUB_ENV
if: github.event_name == 'workflow_run' || (github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'pypi')
- run: |
echo "OIDC_AUDIENCE=testpypi" >> GITHUB_ENV
echo "PYPI_DOMAIN=test.pypi.org" >> GITHUB_ENV
echo "TWINE_REPO=testpypi" >> GITHUB_ENV
if: github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'testpypi'

- run: |
import os

import requests

response = requests.get(
os.environ["ACTIONS_ID_TOKEN_REQUEST_URL"],
params={"audience": os.environ["OIDC_AUDIENCE"]},
headers={"Authorization": f"bearer {os.environ['ACTIONS_ID_TOKEN_REQUEST_TOKEN']}"}
)
response.raise_for_status()
token = response.json()["value"]

response = requests.post(f"https://{os.environ['PYPI_DOMAIN']}/_/oidc/github/mint-token", json={"token": token})
response.raise_for_status()
pypi_token = response.json()["token"]

with open(os.environ["GITHUB_ENV"], "a") as f:
f.write("TWINE_PASSWORD={pypi_token}\n")
shell: python

- run: "twine upload --repository $TWINE_REPO dist/*"
2 changes: 2 additions & 0 deletions .github/workflows/wheel-builder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ on:
inputs:
version:
description: The version to build
# Do not add any non-tag push events without updating pypi-publish.yml. If
# you do, it'll upload wheels to PyPI.
push:
tags:
- '*.*'
Expand Down
118 changes: 0 additions & 118 deletions release.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,144 +2,26 @@
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
# for complete details.

import getpass
import io
import os
import subprocess
import time
import typing
import zipfile

import click
import requests


def run(*args: str) -> None:
print(f"[running] {list(args)}")
subprocess.check_call(list(args))


def wait_for_build_complete_github_actions(
session: requests.Session, token: str, run_url: str
) -> None:
while True:
response = session.get(
run_url,
headers={
"Content-Type": "application/json",
"Authorization": f"token {token}",
},
)
response.raise_for_status()
if response.json()["conclusion"] is not None:
break
time.sleep(3)


def download_artifacts_github_actions(
session: requests.Session, token: str, run_url: str
) -> typing.List[str]:
response = session.get(
run_url,
headers={
"Content-Type": "application/json",
"Authorization": f"token {token}",
},
)
response.raise_for_status()

response = session.get(
response.json()["artifacts_url"],
headers={
"Content-Type": "application/json",
"Authorization": f"token {token}",
},
)
response.raise_for_status()
paths = []
for artifact in response.json()["artifacts"]:
response = session.get(
artifact["archive_download_url"],
headers={
"Content-Type": "application/json",
"Authorization": f"token {token}",
},
)
with zipfile.ZipFile(io.BytesIO(response.content)) as z:
for name in z.namelist():
if not name.endswith(".whl") and not name.endswith(".tar.gz"):
continue
p = z.open(name)
out_path = os.path.join(
os.path.dirname(__file__),
"dist",
os.path.basename(name),
)
with open(out_path, "wb") as f:
f.write(p.read())
paths.append(out_path)
return paths


def fetch_github_actions_artifacts(
token: str, version: str
) -> typing.List[str]:
session = requests.Session()

workflow_runs = []

# There is a race condition where no workflow run has triggered after
# pushing the tag, so loop until we get the run.
while True:
response = session.get(
(
f"https://api.github.com/repos/pyca/cryptography/actions"
f"/workflows/wheel-builder.yml/runs?event=push&"
f"branch={version}"
),
headers={
"Content-Type": "application/json",
"Authorization": f"token {token}",
},
)
response.raise_for_status()
workflow_runs = response.json()["workflow_runs"]
if len(workflow_runs) > 0:
break
time.sleep(3)

run_url: str = workflow_runs[0]["url"]
wait_for_build_complete_github_actions(session, token, run_url)
return download_artifacts_github_actions(session, token, run_url)


@click.command()
@click.argument("version")
def release(version: str) -> None:
"""
``version`` should be a string like '0.4' or '1.0'.
"""
print(
f"Create a new GH PAT with only actions permissions at: "
f"https://github.com/settings/tokens/new?"
f"description={version}&scopes=repo"
)
github_token = getpass.getpass("Github person access token: ")

# Tag and push the tag (this will trigger the wheel builder in Actions)
run("git", "tag", "-s", version, "-m", f"{version} release")
run("git", "push", "--tags")

os.makedirs(os.path.join(os.path.dirname(__file__), "dist"), exist_ok=True)

# Wait for Actions to complete and download the wheels
github_actions_artifact_paths = fetch_github_actions_artifacts(
github_token, version
)

# Upload wheels and sdist
run("twine", "upload", *github_actions_artifact_paths)


if __name__ == "__main__":
release()