Pull Request を分析してレビュー効率とチームパフォーマンスを可視化する¶

pull-request-analytics-actionという GitHub Actions を使って、Pull Request のレビュー効率とチームパフォーマンスを可視化してみた。

チームと開発者個人の有効性を分析するための強力なツールです。このアクションは、プルリクエスト、コードレビュー、コメントのデータに基づいてレポートを生成し、チームの強みや改善が必要な分野を特定することができます。この GitHub アクションによって収集された統計情報は、表やグラフの形で表示したり、マークダウンやデータコレクションとして渡すことができます。情報は外部のサービスには転送されず、すべての操作は GitHub 環境内だけで行われます。このツールには多数の設定パラメータがあり、特定のプロジェクトのニーズに合わせてカスタマイズすることができます。

特徴¶

DeepL で翻訳したものを引用。

レビュータイムライン用のカスタマイズ可能な表とグラフ：PR 開始からレビュー、承認、マージまでの重要なマイルストーンを示すユーザーフレンドリーな表とグラフを生成します。ユーザーは、中央値、平均値（平均）、または選択したパーセンタイルから最適な計算方法を選択できます。この機能は、コードレビュープロセスのボトルネックの特定に役立ちます。

マージされた PR、コード変更、およびレビューに関する包括的なレポート：この機能は、マージされた PR の数、変更されたコードの行数、および実施されたレビューの詳細なレポートを作成します。これは、個々の開発者とチーム全体の作業負荷のおおよその尺度を提供し、生産性と貢献の明確なビューを提供します。

開発者によって開設された PR の品質レポート：この機能は、開発者によってオープンされた PR の品質を分析するレポートを生成します。このレポートは、受け取ったコメントの数、議論された内容、議論の理由、オープンな PR で要求された変更の量に関するデータを表とグラフの両方で表示します。この機能は、コードレビュー中に検出された最も問題のある領域を特定し、その程度を定量化するのに役立ちます。

コードレビュープロセスにおける開発者の関与：この機能は、コードレビューへの開発者の参加レベルを評価します。開始されたディスカッションやコメント、実施されたコードレビューの数や決定事項の内訳を表にして提供します。これにより、レビュープロセスへの開発者の関与を効果的に測定することができます。

主要メトリクスによる注目 PR リスト：pull-request-analytics-action の特筆すべき機能の 1 つは、4 つの主要メトリクス（オープンからレビューまでの時間、レビューから承認までの時間、承認からマージまでの時間、コメント数）に基づいて最も注目すべきプルリクエストのリストを生成する機能です。この機能は、これらの例外的な PR への直接リンクのリストを提供し、迅速なアクセスと詳細な分析を可能にします。

特定のプロジェクトのニーズに合わせて高度にカスタマイズ可能：このアクションは、柔軟性を念頭に設計されており、表示パラメータ、統計収集、およびレポート生成の広範なカスタマイズが可能です。ユーザーは、特定のプロジェクトの要件に正確に適合するようにツールを調整することができ、レポートと分析が可能な限り適切で有用であることを保証します。

GitHub 統合、セキュア、オープンソース：GitHub アクションとして、pull-request-analytics-action は完全に GitHub 環境内で動作します。外部サービスとデータを共有したり保存したりしないため、データのセキュリティとプライバシーが完全に守られます。さらに、オープンソースのツールであるため、動作の完全な透明性を提供し、無償で利用できるため、すべての GitHub ユーザーがアクセス可能です。

使い方¶

公式レポジトリの README に書いてある通りに記述して、そのワークフローを発火するだけで動く。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

name: "PR Analytics"
on:
  workflow_dispatch:
    inputs:
      report_date_start:
        description: "Report date start(d/MM/yyyy)"
        required: false
      report_date_end:
        description: "Report date end(d/MM/yyyy)"
        required: false
jobs:
  create-report:
    name: "Create report"
    runs-on: ubuntu-latest
    steps:
      - name: "Run script for analytics"
        uses: AlexSim93/pull-request-analytics-action@master
        with:
          GITHUB_TOKEN: ${{ secrets.TOKEN }}
          GITHUB_REPO_FOR_ISSUE: "repo"
          GITHUB_OWNER_FOR_ISSUE: "owner"
          GITHUB_OWNERS_REPOS: "owner-1/repo-1"
          CORE_HOURS_START: "9:00"
          CORE_HOURS_END: "19:00"
          TIMEZONE: "Europe/Berlin"
          REPORT_DATE_START: ${{ inputs.report_date_start }}
          REPORT_DATE_END: ${{ inputs.report_date_end }}

例¶

この action を使うと、issue が作られ次のようなレポートを作成できる。

Pull Request report¶

This report based on 50 last updated PRs. To learn more about the project and its configuration, please visit Pull request analytics action.

Below are the settings applied for this report:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

GITHUB_OWNERS_REPOS: owner/repo
GITHUB_OWNER_FOR_ISSUE: issue-owner
GITHUB_REPO_FOR_ISSUE: issue-repo
LABELS: Report
SHOW_STATS_TYPES: timeline, workload, pr-quality, code-review-engagement
TOP_LIST_AMOUNT: 3
AGGREGATE_VALUE_METHODS: percentile
PERCENTILE: 75
TIMEZONE: Europe/Berlin
CORE_HOURS_START: 10:00
CORE_HOURS_END: 19:00
AMOUNT: 50
PERIOD_SPLIT_UNIT: months
EXECUTION_OUTCOME: markdown

Pull requests timeline(percentile75) 12/2023¶

Time to review - time from PR creation to first review. Time to approve - time from PR creation to first approval without requested changes. Time to merge - time from PR creation to merge.

gantt
title Pull requests timeline(percentile75) 12/2023 / minutes
dateFormat X
axisFormat %s
section dev1
                Time to review(3 hours 34 minutes) :  0, 214
Time to approve(7 hours 32 minutes) :  0, 452
Time to merge(14 hours 9 minutes) :  0, 849

section dev2
                Time to review(4 hours) :  0, 240
Time to approve(4 hours) :  0, 240
Time to merge(23 hours 1 minute) :  0, 1381

section dev3
                Time to review(15 hours 16 minutes) :  0, 916
Time to approve(24 hours 7 minutes) :  0, 1447
Time to merge(53 hours 43 minutes) :  0, 3223

section dev4
                Time to review(2 hours 41 minutes) :  0, 161
Time to approve(9 hours 15 minutes) :  0, 555
Time to merge(47 hours 41 minutes) :  0, 2861

section dev5
                Time to review(5 hours 59 minutes) :  0, 359
Time to approve(18 hours 55 minutes) :  0, 1135
Time to merge(40 hours 7 minutes) :  0, 2407

section total
                Time to review(4 hours 21 minutes) :  0, 261
Time to approve(7 hours 36 minutes) :  0, 456
Time to merge(26 hours 14 minutes) :  0, 1574

longest-pending reviews¶

1. Feature: PR Title(example) (7 hours 26 minutes)
2. Feature: PR Title(example) (7 hours 20 minutes)
3. Feature: PR Title(example) (7 hours 10 minutes)

longest-pending approvals¶

1. Feature: PR Title(example) (2 hours 15 minutes)
2. Feature: PR Title(example) (2 hours 7 minutes)
3. Feature: PR Title(example) (2 hours 3 minutes)

longest-pending merge¶

1. Feature: PR Title(example) (2 hours 33 minutes)
2. Feature: PR Title(example) (2 hours 30 minutes)
3. Feature: PR Title(example) (2 hours 12 minutes)

Workload stats 12/2023¶

Reviews conducted - number of reviews conducted. 1 PR may have only single review.

PR Size - determined using the formula: additions + deletions * 0.5. Based on this calculation: 0-50: xs, 51-200: s, 201-400: m, 401-700: l, 701+: xl

Pull request quality 12/2023¶

Agreed - discussions with at least 1 reaction .

Disagreed - discussions with at least 1 reaction .

The most commented PRs¶

1. Feature: PR Title(example)(18)
2. Feature: PR Title(example)(16)
3. Feature: PR Title(example)(15)

Code review engagement 12/2023¶

PR Size - determined using the formula: additions + deletions * 0.5. Based on this calculation: 0-50: xs, 51-200: s, 201-400: m, 401-700: l, 701+: xl

Changes requested / Comments / Approvals - number of reviews conducted by user. For a single pull request, only one review of each status will be counted for a user.

Agreed - discussions with at least 1 reaction .

Disagreed - discussions with at least 1 reaction .

Pull requests timeline(percentile75) total¶

Time to review - time from PR creation to first review.

Time to approve - time from PR creation to first approval without requested changes.

Time to merge - time from PR creation to merge.

gantt
title Pull requests timeline(percentile75) total / minutes
dateFormat X
axisFormat %s
section dev1
                Time to review(3 hours 34 minutes) :  0, 214
Time to approve(7 hours 32 minutes) :  0, 452
Time to merge(14 hours 9 minutes) :  0, 849

section dev2
                Time to review(4 hours) :  0, 240
Time to approve(4 hours) :  0, 240
Time to merge(23 hours 1 minute) :  0, 1381

section dev3
                Time to review(15 hours 16 minutes) :  0, 916
Time to approve(24 hours 7 minutes) :  0, 1447
Time to merge(53 hours 43 minutes) :  0, 3223

section dev4
                Time to review(2 hours 41 minutes) :  0, 161
Time to approve(9 hours 15 minutes) :  0, 555
Time to merge(47 hours 41 minutes) :  0, 2861

section dev5
                Time to review(5 hours 59 minutes) :  0, 359
Time to approve(18 hours 55 minutes) :  0, 1135
Time to merge(40 hours 7 minutes) :  0, 2407

section total
                Time to review(4 hours 21 minutes) :  0, 261
Time to approve(7 hours 36 minutes) :  0, 456
Time to merge(26 hours 14 minutes) :  0, 1574

longest-pending reviews¶

1. Feature: PR Title(example) (7 hours 26 minutes)
2. Feature: PR Title(example) (7 hours 20 minutes)
3. Feature: PR Title(example) (7 hours 10 minutes)

longest-pending approvals¶

1. Feature: PR Title(example) (2 hours 15 minutes)
2. Feature: PR Title(example) (2 hours 7 minutes)
3. Feature: PR Title(example) (2 hours 3 minutes)

longest-pending merge¶

1. Feature: PR Title(example) (2 hours 33 minutes)
2. Feature: PR Title(example) (2 hours 30 minutes)
3. Feature: PR Title(example) (2 hours 12 minutes)

Workload stats total¶

Reviews conducted - number of reviews conducted. 1 PR may have only single review.

PR Size - determined using the formula: additions + deletions * 0.5. Based on this calculation: 0-50: xs, 51-200: s, 201-400: m, 401-700: l, 701+: xl

Pull request quality total¶

Agreed - discussions with at least 1 reaction .

Disagreed - discussions with at least 1 reaction .

The most commented PRs¶

1. Feature: PR Title(example)(18)
2. Feature: PR Title(example)(16)
3. Feature: PR Title(example)(15)

Code review engagement total¶

PR Size - determined using the formula: additions + deletions * 0.5. Based on this calculation: 0-50: xs, 51-200: s, 201-400: m, 401-700: l, 701+: xl

Changes requested / Comments / Approvals - number of reviews conducted by user. For a single pull request, only one review of each status will be counted for a user.

Agreed - discussions with at least 1 reaction .

Disagreed - discussions with at least 1 reaction .