Pull Request Stats

Github action to print relevant stats about Pull Request reviewers.

The objective of this action is to:

Reduce the time taken to review the pull requests.
Encourage quality on reviews.
Help to decide which people to assign as reviewers.

Running this action will add a section at the bottom of your pull requests description:

Each reviewer has a link pointing to their historical behavior)) of each reviewer:

Or send the data to your favorite tools by using the integrations available:

Slack	MS Teams	Webhooks

Privacy

No repository data is collected, stored, or distributed by this GitHub action. This action is state-less.
Charts data is sent over the URL and never stored or transmitted anywhere else.
Minimal data is sent to Mixpanel in order to improve this action. However, you can opt-out using the telemetry option.

Usage

Just add this action to one of your workflow files:

      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@master

If you are getting an empty table or an error, check the troubleshooting section.

Action inputs

The possible inputs for this action are:

Parameter	Description	Default
`token`	A Personal Access Token with `repo` permissions. Required to calculate stats for an organization or multiple repos.	`GITHUB_TOKEN`
`repositories`	A comma-separated list of GitHub repositories to calculate the stats, e.g. `username/repo1,username/repo2`. When specifying other repo(s), it is mandatory to pass a Personal Access Token in the `token` parameter.	Current repository
`organization`	If you prefer, you may specify your organization's name to calculate the stats across all of its repos. When specifying an organization, it is mandatory to pass a Personal Access Token in the `token` parameter.	`null`
`period`	The period used to calculate the stats, expressed in days.	`30`
`limit`	The maximum number of rows to display in the table. A value of `0` means unlimited.	`0`
`charts`	Whether to add a chart to the start. Possible values: `true` or `false`.	`false`
`disableLinks`	If `true`, removes the links to the detailed charts. Possible values: `true` or `false`.	`false`
`sortBy`	The column used to sort the data. Possible values: `REVIEWS`, `TIME`, `COMMENTS`.	`REVIEWS`
`publishAs`	Where to publish the results. Possible values: as a `COMMENT`, on the pull request `DESCRIPTION`, or publish `NONE`.	`COMMENT`
`exclude`	A comma-separated list of usernames (case-insensitive) to be excluded from the results (e.g. `username1,username2`), or a regular expression enclosed between slashes (eg. `/^bot/i` will exclude all usernames that begin with "bot").	`null`
`telemetry`	Indicates if the action is allowed to send monitoring data to the developer. This data is minimal and helps me improve this action. This option is a premium feature reserved for sponsors.	`true`
`slackWebhook`	🔥 New. A Slack webhook URL to post resulting stats. This option is a premium feature reserved for sponsors. See full documentation here.	`null`
`slackChannel`	The Slack channel where stats will be posted. Include the `#` character (eg. `#mychannel`). Required when a `slackWebhook` is configured.	`null`
`teamsWebhook`	🔥 New. A Microsoft Teams webhook URL to post resulting stats. This option is a premium feature reserved for sponsors. See full documentation here.	`null`
`webhook`	🔥 New. A webhook URL to send the resulting stats as JSON (integrate with Zapier, IFTTT...). See full documentation here.	`null`

Action outputs

This action outputs the following variables:

Variable	Description
`resultsMd`	The resulting stats stored as a step output variable in Markdown format.
`resultsJson`	The resulting stats stored as a step output variable in JSON format.

Examples

Minimal config

Add this to the file .github/workflows/stats.yml in your repo:

name: Pull Request Stats

on:
  pull_request:
    types: [opened]

jobs:
  stats:
    runs-on: ubuntu-latest
    steps:
      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@master

This config will:

Calculate the reviewer stats for the current repo in the lasts 30 days.
Add links to the historical data.
Sort results by the "total reviews" column by default.

and print a table like this:

User	Total reviews	Median time to review	Total comments
jartmez	37	22m))	13
manuelmhtr	35	48m))	96
ernestognw	25	1h 27m))	63
javierbyte	12	30m))	0
Phaze1D	4	34m))	1

Visual config

Add this to the file .github/workflows/stats.yml:

name: Pull Request Stats

on:
  pull_request:
    types: [opened]

jobs:
  stats:
    runs-on: ubuntu-latest
    steps:
      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@master
        with:
          token: ${{ secrets.ADD_A_PERSONAL_ACCESS_TOKEN }}
          organization: 'piedpiper'
          period: 7
          charts: true
          disableLinks: true
          sortBy: 'COMMENTS'

This config will:

Calculate the reviewer stats for all the repos in the "piedpiper" organization in the lasts 7 days.
Display charts for the metrics.
Remove the links to detailed charts.
Sort results by the "comments" column.

and print a table like this:

User	Total comments	Total reviews	Median time to review
manuelmhtr 🥇	12 ▀▀▀▀▀▀▀▀	8 ▀▀▀▀	53m
CarlosCRG19 🥈	3 ▀▀	4 ▀▀	58m
jartmez 🥉	1 ▀	2 ▀	1d 16h 18m ▀▀▀▀▀▀
Estebes10	1 ▀	1	19m
ernestognw	0	2 ▀	2h 15m
Phaze1D	0	3 ▀	1h 28m
javierbyte	0	1	21h 24m ▀▀▀

Stats

The stats are calculated as follows:

Time to review: The time a reviewer takes from the Pull Request publication or the last Commit push (whatever happens last) to the first time the pull request is reviewed.
Time to review: The median of the times to review of all Pull Requests reviewed by a person in the period.
Total reviews: The count of all Pull Requests reviewed by a person in the period.
Total comments: The number of comments made while reviewing other users' Pull Requests during the specified period. Comments made on your own PRs or general PR discussions are excluded; only comments directly related to code are counted.

Integrations 🔌

Check the guide for the tool you want to integrate:

Troubleshooting

The action is printing an empty table.

1. Make sure the repositories have pull request reviews during the configured `period`. 2. When specifying `repositories` or `organization` parameters, a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required in the `token` parameter. 3. If providing a Personal Access Token, ensure it has the `repo` permission for the projects you want. 4. If you are not providing a Personal Access Token (thus, the action is using the default `GITHUB_TOKEN`), make sure the job has the `contents: read` and `pull-requests: write` [permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#defining-access-for-the-github_token-scopes) While these permissions are typically provided by default, certain organizations may customize or overwrite them. ```yml jobs: stats: runs-on: ubuntu-latest permissions: contents: read pull-requests: write steps: - name: Run pull request stats uses: flowwer-dev/pull-request-stats@master ```

I get the error "Error commenting on the pull request...".

This error happens when the organization configures the action's permissions as `read`. To fix it, overwrite them by adding a [`permissions`](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) configuration in the workflow file. The minimum required permissions are `contents: read` and `pull-requests: write`: ```yml jobs: stats: runs-on: ubuntu-latest permissions: contents: read pull-requests: write steps: - name: Run pull request stats uses: flowwer-dev/pull-request-stats@master ```

I'm a sponsor but still getting the error "...is a premium feature, available to sponsors".

1. Check the sponsorship comes from the account that owns the configured repos (usually an organization). 2. Make sure the sponsorship is configured as `public`, otherwise, the action cannot access the sponsorship information. If you prefer to keep it `private`, please reach me out to make it work for you that way 😉.

Premium features ✨

This action offers some premium features only for sponsors:

Disabling telemetry.
Slack integration.
Microsoft Teams integration.
Coming soon: Discord integration, web version.

The suggested sponsorship is $20 USD / month. However, if it's not possible for you or your organization, please consider supporting it with any amount you can. Even a one-time sponsorship will enable the Premium features and encourage the progress of this project.

Being a sponsor will also give you access to the premium features in all of my other projects.

Thanks for your support! 💙