Automatically Add Reviewers to Pull Requests #5948
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
makubacki
requested review from
spbrogan,
bcran,
lgao4,
BobCF,
mdkinney,
Javagedes and
YuweiChen1110
makubacki
force-pushed
the
auto_pr_reviewers_edk2
branch
from
54d49db
to
b70a97b
Compare
mdkinney
reviewed
Jul 23, 2024
spbrogan
approved these changes
Jul 24, 2024
|
The commit message for the workflow needs tweaking. I added two changes below highlighting using "**".
|
mdkinney
approved these changes
Jul 24, 2024
makubacki
force-pushed
the
auto_pr_reviewers_edk2
branch
from
b70a97b
to
2f0d919
Compare
Adds a new `-g` parameter so that output will also include the GitHub username. This change uses a simple regular expression as opposed to directly returning the original line from the file to make the extraction of GitHub usernames more robust to other changes on the line in the maintainers text file. Signed-off-by: Michael Kubacki <[email protected]>
makubacki
force-pushed
the
auto_pr_reviewers_edk2
branch
from
2f0d919
to
810310c
Compare
|
Going to make another small change before this is ready. |
Adds a script that provides GitHub API helpers for workflows and other GitHub automation in the repository. Signed-off-by: Michael Kubacki <[email protected]>
makubacki
force-pushed
the
auto_pr_reviewers_edk2
branch
from
810310c
to
fe459f9
Compare
Done |
makubacki
force-pushed
the
auto_pr_reviewers_edk2
branch
from
fe459f9
to
39b89b4
Compare
makubacki
added
push
makubacki
force-pushed
the
auto_pr_reviewers_edk2
branch
2 times, most recently
from
1cd7600
to
69c0bfb
Compare
Adds a new GitHub workflow to automatically add reviewers to pull requests when they are opened, reopened, synchronized, and if a draft pull request is marked as ready for review. The workflow will not run on draft pull requests. The workflow is meant to be simple to understand and modify, relying on existing logic in GetMaintainer.py to determine the relevant reviewers and using simple Python GitHub REST API wrappers with the default GitHub token for authentication. Future changes may optimize the workflow. Signed-off-by: Michael Kubacki <[email protected]>
makubacki
force-pushed
the
auto_pr_reviewers_edk2
branch
from
69c0bfb
to
5fe80a5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
A series of changes to automate reviewers being added to pull requests in edk2.
Long term, it is preferred to exclusively depend upon GitHub Code Owners. This
PR is meant to provide an immediate solution to adding reviewers to PRs while
opens around CODEOWNERS are closed.
This wiki page has some details about the workflow Automatic Pull Request Reviewer Details.
BaseTools/GetMaintainer.py: Add GitHub username argument
Adds a new
-gparameter so that output will also include the GitHubusername.
This change uses a simple regular expression as opposed to directly
returning the original line from the file to make the extraction of
GitHub usernames more robust to other changes on the line in the
maintainers text file.
.github: Add GitHub python script
Adds a script that provides GitHub API helpers for automation scripts
in the repository.
.github/workflows/request-reviews.yml: Add workflow
Adds a new GitHub workflow to automatically add reviewers to pull
requests when they are opened, reopened, synchronized, and if a draft
pull request is marked as ready for review. The workflow will not
run on draft pull requests.
The workflow is meant to be simple to understand and modify, relying
on existing logic in GetMaintainer.py to determine the relevant
reviewers and using simple Python GitHub REST API wrappers with the
default GitHub token for authentication.
Future changes may optimize the workflow.
How This Was Tested
Integration Instructions
You can see this workflow running in the tianocore/edk2 repo (for this PR) here.