This GitHub Action analyzes and displays statistics related to pull request reviewers and contributors, aiming to improve team performance, reduce review times, and encourage review quality. It's designed for development teams and project managers seeking data-driven insights into their code review process.

How It Works

The action integrates with GitHub workflows to collect data on reviewer activity, such as total reviews, time to review, and comments per review. It processes this data to generate sortable tables and optional charts, which can be embedded directly into pull request descriptions or sent to external platforms like Slack or Microsoft Teams via webhooks.

Quick Start & Requirements

• Install: Add uses: flowwer-dev/pull-request-stats@main to your GitHub Actions workflow file.
• Prerequisites: Requires a GitHub repository with pull requests. For cross-repository or organization-wide stats, a GitHub Personal Access Token with repo permissions is needed. Specific permissions (contents: read, pull-requests: write) may need to be explicitly set at the job level if not default.
• Links: Usage Examples, Troubleshooting

Highlighted Details

• Tracks various review metrics including totalReviews, timeToReview, totalComments, commentsPerReview, reviewedAdditions, reviewedDeletions, and reviewedLines.
• Also tracks performance metrics like openedPullRequests, revisionSuccessRate, and lines added/deleted.
• Supports filtering by specific users (include, exclude) and date periods.
• Offers integrations with Slack, Microsoft Teams, and generic webhooks.

Maintenance & Community

• Maintained by @manuelmhtr and @CarlosCRG19.
• Encourages community support through starring, feedback, and sponsorship.
• Premium features are available for sponsors, with a suggested sponsorship of $20 USD/month.
• A standalone web version is also available.

Licensing & Compatibility

• License: MIT
• Compatibility: Permissive MIT license allows for commercial use and integration with closed-source projects.

Limitations & Caveats

Telemetry and advanced integrations (Slack, Teams) are premium features requiring sponsorship. The action's ability to comment on PRs can be blocked by organization-level permission settings, requiring explicit configuration.