ray/release/util/get_contributors.py

from github import Github
from subprocess import check_output
import shlex
from tqdm import tqdm
import click
from collections import defaultdict


@click.command()
@click.option(
    "--access-token",
    required=True,
    help="""
Github Access token that has repo:public_repo and user:read:user permission.

Create them at https://github.com/settings/tokens/new
""",
)
@click.option(
    "--prev-release-commit",
    required=True,
    help="Last commit SHA of the previous release.",
)
@click.option(
    "--curr-release-commit",
    required=True,
    help="Last commit SHA of the current release.",
)
def run(access_token, prev_release_commit, curr_release_commit):
    print("Writing commit descriptions to 'commits.txt'...")
    check_output(
        (
            f"git log {prev_release_commit}..{curr_release_commit} "
            f"--pretty=format:'%s' > commits.txt"
        ),
        shell=True,
    )
    # Generate command
    cmd = []
    cmd.append(
        (
            f"git log {prev_release_commit}..{curr_release_commit} "
            f'--pretty=format:"%s" '
            f' | grep -Eo "#(\d+)"'
        )
    )
    joined = " && ".join(cmd)
    cmd = f"bash -c '{joined}'"
    cmd = shlex.split(cmd)
    print("Executing", cmd)

    # Sort the PR numbers
    pr_numbers = [int(line.lstrip("#")) for line in check_output(cmd).decode().split()]
    print("PR numbers", pr_numbers)

    # Use Github API to fetch the
    g = Github(access_token)
    ray_repo = g.get_repo("ray-project/ray")
    logins = set()
    for num in tqdm(pr_numbers):
        try:
            logins.add(ray_repo.get_pull(num).user.login)
        except Exception as e:
            print(e)

    print()
    print("Here's the list of contributors")
    print("=" * 10)
    print()
    print("@" + ", @".join(logins))
    print()
    print("=" * 10)

    # Organize commits
    NO_CATEGORY = "[NO_CATEGORY]"

    def get_category(line):
        if line[0] == "[":
            return (line.split("]")[0].strip(" ") + "]").upper()
        else:
            return NO_CATEGORY

    commits = defaultdict(list)

    with open("commits.txt") as file:
        for line in file.readlines():
            commits[get_category(line)].append(line.strip())

    with open("commits.txt", "a") as file:
        for category, commit_msgs in commits.items():
            file.write("\n{}\n".format(category))
            for commit_msg in commit_msgs:
                file.write("{}\n".format(commit_msg))


if __name__ == "__main__":
    run()