actions/pypi-publish
1
0
Fork 0
mirror of https://github.com/pypa/gh-action-pypi-publish.git synced 2024-11-09 10:23:35 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #139 from trail-of-forks/tob-improve-errors

Browse source 
This change improves the error output produced within the OIDC token exchange script by adding a title and a link to the Warehouse documentation for trusted publishers.

Ref #138.
This commit is contained in:
Sviatoslav Sydorenko 2023-04-01 04:10:38 +02:00 committed by GitHub
commit 29930c9cf5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
oidc-exchange.py
View file

@ -10,6 +10,16 @@ import requests
_GITHUB_STEP_SUMMARY = Path(os.getenv("GITHUB_STEP_SUMMARY")) _GITHUB_STEP_SUMMARY = Path(os.getenv("GITHUB_STEP_SUMMARY"))
# The top-level error message that gets rendered.
# This message wraps one of the other templates/messages defined below.
_ERROR_SUMMARY_MESSAGE = """
Trusted publisher (OIDC) exchange failure:
{message}
Read more about trusted publishers at https://docs.pypi.org/trusted-publishers/
"""
# Rendered if OIDC identity token retrieval fails for any reason. # Rendered if OIDC identity token retrieval fails for any reason.
_TOKEN_RETRIEVAL_FAILED_MESSAGE = """ _TOKEN_RETRIEVAL_FAILED_MESSAGE = """
OIDC token retrieval failed: {identity_error} OIDC token retrieval failed: {identity_error}
@ -53,7 +63,7 @@ a few minutes and try again.
def die(msg: str) -> NoReturn: def die(msg: str) -> NoReturn:
with _GITHUB_STEP_SUMMARY.open("a", encoding="utf-8") as io: with _GITHUB_STEP_SUMMARY.open("a", encoding="utf-8") as io:
print(msg, file=io) print(_ERROR_SUMMARY_MESSAGE.format(message=msg), file=io)
print(f"::error::OIDC exchange failure: {msg}", file=sys.stderr) print(f"::error::OIDC exchange failure: {msg}", file=sys.stderr)
sys.exit(1) sys.exit(1)