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

• 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.

Just add this action to one of your workflow files:

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

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

The possible inputs for this action are:

This action outputs the following variables:

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@main

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@main
        with:
          token: ${{ secrets.ADD_A_PERSONAL_ACCESS_TOKEN }}
          organization: 'piedpiper'
          period: 7
          charts: true
          disableLinks: true
          sortBy: 'totalComments'
          stats: 'totalComments,openedPullRequests'

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 "Total comments" column.
• Show the "Total comments" and "Opened pull requests" columns (in that order).

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 ▀▀▀

The stats are calculated as follows:

• Total reviews (totalReviews): The count of all Pull Requests reviewed by a person in the period.
• Time to review (timeToReview): The median 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.
• Total comments (totalComments): 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.
• Comments per review (commentsPerReview): The average comments the reviewer made on the pull requests.
• Opened pull requests (openedPullRequests): The number of pull requests opened by the user in the period.

Check the guide for the tool you want to integrate:

• Slack
• Microsoft Teams
• Webhooks

jobs:
  stats:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@main

jobs:
  stats:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@main

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! 💙

• Recap: Tired of writing pull request descriptions? Let GPT do it for you.

Used by hundreds of successful teams:

Sixt	Lululemon	Delivery H	JOKR	Lego	LOOP	Hatch	Zenfi
Intel	Auth0	Addition	Fauna	CDC	Wecasa	Bolt	Republic

	@manuelmhtr 🇲🇽 Guadalajara, MX
	@CarlosCRG19 🇲🇽 Colima, MX

This project is maintained by a small team, considering supporting the project by:

• ⭐ Star this repo.
• Sharing your feedback.
• Joining the community.
• Becoming a sponsor.

Breaking News! We’ve unleashed the stand-alone version of this action!

• Filter by repositories and date range.
• Stats tracking over the time.
• Tons of new features coming soon!

MIT