nyholm/git-reviewer

Find a good reviewer to your github pull request

0.2.0 2024-01-08 13:28 UTC

Requires

• bref/logger: ^1.0
• knplabs/github-api: ^v3.13.0
• nyholm/psr7: ^1.3
• symfony/cache: ^6.4 || ^7.0
• symfony/config: ^6.4 || ^7.0
• symfony/console: ^6.4 || ^7.0
• symfony/dependency-injection: ^6.4 || ^7.0
• symfony/event-dispatcher: ^6.4 || ^7.0
• symfony/filesystem: ^6.4 || ^7.0
• symfony/http-client: ^6.4 || ^7.0
• symfony/process: ^6.4 || ^7.0
• symfony/yaml: ^6.4 || ^7.0

Requires (Dev)

• symfony/phpunit-bridge: ^6.4 || ^7.0

MIT

• Nyholm

README

This is a small PHP (Symfony) application that find you reviewers to a Github pull request.

It is using a naive algorithm which:

1. First looks at the modified files in the PR
2. Do a git blame on each file to see who as modified the file
3. Sort the list of contributor, first contributor is the person that have changed the most files that the pull request touches

$ ./git-reviewer.php find 106 /path/to/local/repository --pretty-print

[
    {
        "email": "[e-mail]",
        "name": "Tobias Nyholm",
        "contributions": 3,
        "username": "Nyholm"
    },
    {
        "email": "[e-mail]",
        "name": "Ion Bazan",
        "contributions": 1,
        "username": "IonBazan"
    }
]

Documentation

The first argument to ./git-reviewer.php is the "command name". Here is a short description of each command name and their additional arguments and options.

cache:clear

Clears the application's cache. It does not clear the var/storage.

$ ./git-reviewer.php cache:clear

pull-request:base

Finds the branch that the pull request target.

$ ./git-reviewer.php pull-request:base 123 /path/to/local/repository

master

find

Get a list of possible reviewers.

$ ./git-reviewer.php find 123 /path/to/local/repository

[
    {
        "email": "[e-mail]",
        "name": "Tobias Nyholm",
        "contributions": 3,
        "username": "Nyholm"
    },
    ...
]

Options:

Name	Example	Description
after	2020-01-01	Only look at contributions after a specific date.
ignore-path	.env "config/*" "src/**/Tests"	Exclude paths and files when searching for contributors. An astrix matches everything but "/" and double astrix matches everything.
no-username		Don't search for the users' username. You will only get name and email.
pretty-print		Make the output more easy to read for humans.

$ ./git-reviewer.php find 123 /path/to/local/repository --ignore-path "config/*" --ignore-path .env --after 2020-01-01 --no-username --pretty-print

Calls to Github API

Github allows some anonymous calls, but it is a good idea to specify an environment variable named GITHUB_TOKEN. That should contain a Github token with "api" permissions.

You can create such token in your Github account under "Developer settings > Personal access tokens".