tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-27 07:34:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

.github/request-reviews.yml: Improve doc and dbg messages

Browse Source 
Adds additional documentation and cleans up debug messages printed
to GitHub workflow output (available in the GitHub Actions pane).

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
This commit is contained in:
Michael Kubacki 2024-07-31 19:04:06 -04:00 committed by mergify[bot]
parent f617b6ee0e
commit 32a099c358
2 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
.github/scripts/GitHub.py vendored
View File

@ -89,8 +89,11 @@ def get_reviewers_for_range(
) -> List[str]:
"""Get the reviewers for the current branch.
To get the reviewers for a single commit, set `range_start` and
`range_end` to the commit SHA.
!!! note
This function accepts a range of commits and returns the reviewers
for that set of commits as a single list of GitHub usernames. To get
the reviewers for a single commit, set `range_start` and `range_end`
to the commit SHA.
Args:
workspace_path (str): The workspace path.
@ -189,6 +192,13 @@ def add_reviewers_to_pr(
reviewers to the PR. This list will exclude any reviewers
from the list provided if they are not relevant to the PR.
"""
if not user_names:
print(
"::debug title=No PR Reviewers Requested!::"
"The list of PR reviewers is empty so not adding any reviewers."
)
return []
try:
g = _authenticate(token)
repo_gh = g.get_repo(f"{owner}/{repo}")
@ -200,8 +210,10 @@ def add_reviewers_to_pr(
)
return None
# The pull request author cannot be a reviewer.
pr_author = pr.user.login.strip()
# The current PR reviewers do not need to be requested again.
current_pr_requested_reviewers = [
r.login.strip() for r in pr.get_review_requests()[0]
]
@ -210,15 +222,17 @@ def add_reviewers_to_pr(
set(current_pr_requested_reviewers + current_pr_reviewed_reviewers)
)
# A user can only be added if they are a collaborator of the repository.
repo_collaborators = [c.login.strip() for c in repo_gh.get_collaborators()]
non_collaborators = [u for u in user_names if u not in repo_collaborators]
excluded_pr_reviewers = [pr_author] + current_pr_reviewers + non_collaborators
new_pr_reviewers = [u for u in user_names if u not in excluded_pr_reviewers]
# Notify the admins of the repository if non-collaborators are requested.
if non_collaborators:
print(
f"::error title=User is not a Collaborator!::{', '.join(non_collaborators)}"
f"::warning title=Non-Collaborator Reviewers Found!::{', '.join(non_collaborators)}"
)
for comment in pr.get_issue_comments():

5
.github/workflows/request-reviews.yml vendored
View File

@ -74,14 +74,17 @@ jobs:
WORKSPACE_PATH = os.environ['WORKSPACE_PATH']
GET_MAINTAINER_LOCAL_PATH = os.path.join(WORKSPACE_PATH, os.environ['GET_MAINTAINER_REL_PATH'])
# Step 1: Get the GitHub created PR commit SHA (contains all changes in a single commit)
pr_commit_sha = GitHub.get_pr_sha(os.environ['GH_TOKEN'], os.environ['ORG_NAME'], os.environ['REPO_NAME'], int(os.environ['PR_NUMBER']))
if not pr_commit_sha:
sys.exit(1)
print(f"::notice title=PR Commit SHA::Looking at files in consolidated PR commit: {pr_commit_sha}")
# Step 2: Fetch only the PR commit to get the files changed in the PR
git.Repo(WORKSPACE_PATH).remotes.origin.fetch(pr_commit_sha, depth=1)
# Step 3: Get the list of reviewers for the PR
reviewers = GitHub.get_reviewers_for_range(WORKSPACE_PATH, GET_MAINTAINER_LOCAL_PATH, pr_commit_sha, pr_commit_sha)
if not reviewers:
print("::notice title=No New Reviewers Found!::No reviewers found for this PR.")
@ -92,6 +95,8 @@ jobs:
f"PR {os.environ['PR_NUMBER']}: {', '.join(reviewers)}"
)
# Step 4: Add the reviewers to the PR
# Note the final requested reviewer list in the workflow run for reference
new_reviewers = GitHub.add_reviewers_to_pr(
os.environ["GH_TOKEN"],
os.environ["ORG_NAME"],