Skip to content

workflows: Add some automation for commit access requests #123113

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 7 commits into from
Jan 31, 2025
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
39 changes: 39 additions & 0 deletions .github/workflows/commit-access-greeter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Commit Access Greeter

on:
issues:
types:
- labeled

permissions:
contents: read

jobs:
commit-access-greeter:
permissions:
issues: write
if: >-
github.repository_owner == 'llvm' &&
github.event.label.name == 'infra:commit-access-request'
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
with:
sparse-checkout: llvm/utils/git/

- name: Setup Automation Script
working-directory: ./llvm/utils/git/
run: |
pip install --require-hashes -r requirements.txt

- name: Add comments to issue
working-directory: ./llvm/utils/git/
env:
LABEL_NAME: ${{ github.event.label.name }}
GITHUB_TOKEN: ${{ github.token }}
ISSUE_NUMBER: ${{ github.event.issue.number }}
run: |
python3 ./github-automation.py \
--token $GITHUB_TOKEN \
commit-request-greeter \
--issue-number $ISSUE_NUMBER
69 changes: 69 additions & 0 deletions llvm/utils/git/github-automation.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import re
import requests
import sys
import textwrap
import time
from typing import List, Optional

Expand Down Expand Up @@ -209,6 +210,14 @@ def _get_current_team(self) -> Optional[github.Team.Team]:
return None


def get_top_values(values: dict, top: int = 3) -> list:
return [v for v in sorted(values.items(), key=lambda x: x[1], reverse=True)][:top]


def get_user_values_str(values: list) -> str:
return ", ".join([f"@{v[0]} ({v[1]})" for v in values])


class PRGreeter:
COMMENT_TAG = "<!--LLVM NEW CONTRIBUTOR COMMENT-->\n"

Expand Down Expand Up @@ -241,6 +250,60 @@ def run(self) -> bool:
return True


class CommitRequestGreeter:
def __init__(self, token: str, repo: str, issue_number: int):
self.repo = github.Github(token).get_repo(repo)
self.issue = self.repo.get_issue(issue_number)

def run(self) -> bool:
# Post greeter comment:
comment = textwrap.dedent(
f"""
@{self.issue.user.login} thank you for apply for commit access. Please review the project's [code review policy](https://llvm.org/docs/CodeReview.html).
"""
)
self.issue.create_comment(comment)

# Post activity summary:
total_prs = 0
merged_prs = 0
merged_by = {}
reviewed_by = {}
for i in self.repo.get_issues(creator=self.issue.user.login, state="all"):
issue_reviewed_by = set()
try:
pr = i.as_pull_request()
total_prs += 1
for c in pr.get_review_comments():
if c.user.login == self.issue.user.login:
continue
issue_reviewed_by.add(c.user.login)
for r in issue_reviewed_by:
if r not in reviewed_by:
reviewed_by[r] = 1
else:
reviewed_by[r] += 1
if pr.is_merged():
merged_prs += 1
merger = pr.merged_by.login
if merger not in merged_by:
merged_by[merger] = 1
else:
merged_by[merger] += 1
continue

except github.GithubException:
continue

comment = f"""
### Activity Summary:
* [{total_prs} Pull Requests](https://github.com/llvm/llvm-project/pulls/{self.issue.user.login}) ({merged_prs} merged)
* Top 3 Committers: {get_user_values_str(get_top_values(merged_by))}
* Top 3 Reviewers: {get_user_values_str(get_top_values(reviewed_by))}
"""
self.issue.create_comment(textwrap.dedent(comment))


class PRBuildbotInformation:
COMMENT_TAG = "<!--LLVM BUILDBOT INFORMATION COMMENT-->\n"

Expand Down Expand Up @@ -676,6 +739,9 @@ def request_release_note(token: str, repo_name: str, pr_number: int):
pr_greeter_parser = subparsers.add_parser("pr-greeter")
pr_greeter_parser.add_argument("--issue-number", type=int, required=True)

commit_request_greeter = subparsers.add_parser("commit-request-greeter")
commit_request_greeter.add_argument("--issue-number", type=int, required=True)

pr_buildbot_information_parser = subparsers.add_parser("pr-buildbot-information")
pr_buildbot_information_parser.add_argument("--issue-number", type=int, required=True)
pr_buildbot_information_parser.add_argument("--author", type=str, required=True)
Expand Down Expand Up @@ -746,6 +812,9 @@ def request_release_note(token: str, repo_name: str, pr_number: int):
elif args.command == "pr-greeter":
pr_greeter = PRGreeter(args.token, args.repo, args.issue_number)
pr_greeter.run()
elif args.command == "commit-request-greeter":
commit_greeter = CommitRequestGreeter(args.token, args.repo, args.issue_number)
commit_greeter.run()
elif args.command == "pr-buildbot-information":
pr_buildbot_information = PRBuildbotInformation(
args.token, args.repo, args.issue_number, args.author
Expand Down