<p data-line="1" class="code-line">PRのコードレビューを自動化したいと思いました。GitHub Copilot code reviewを使えば、PRを作成するたびに自動でレビューが走るようにできます。設定方法を調べたので備忘録です。</p>
<h2 id="github-copilot-code-review%E3%81%A8%E3%81%AF" data-line="3" class="code-line"><a class="header-anchor-link" href="#github-copilot-code-review%E3%81%A8%E3%81%AF" aria-hidden="true"></a> GitHub Copilot code reviewとは</h2>
<p data-line="5" class="code-line">GitHub Copilot code reviewは、PRのコードをCopilotが自動でレビューしてくれる機能です。セキュリティの問題やコードの改善点を指摘してくれます。</p>
<p data-line="7" class="code-line">私が気に入っているポイントは以下です。</p>
<ul data-line="9" class="code-line">
<li data-line="9" class="code-line"><strong>修正提案がそのまま適用できる</strong> ：指摘にはコード修正が含まれており、数クリックで適用できる</li>
<li data-line="10" class="code-line"><strong>すべての言語に対応</strong> ：特定の言語に限らず使える</li>
<li data-line="11" class="code-line"><strong>静的解析ツールと連携可能</strong> ：CodeQL、ESLint、PMDと組み合わせられる</li>
</ul>
<h2 id="%E5%88%A9%E7%94%A8%E6%9D%A1%E4%BB%B6" data-line="13" class="code-line"><a class="header-anchor-link" href="#%E5%88%A9%E7%94%A8%E6%9D%A1%E4%BB%B6" aria-hidden="true"></a> 利用条件</h2>
<p data-line="15" class="code-line">Copilot code reviewはプレミアム機能です。以下のプランで利用できます。</p>
<ul data-line="17" class="code-line">
<li data-line="17" class="code-line">Copilot Pro</li>
<li data-line="18" class="code-line">Copilot Pro+</li>
<li data-line="19" class="code-line">Copilot Business</li>
<li data-line="20" class="code-line">Copilot Enterprise</li>
</ul>
<p data-line="22" class="code-line">Copilot Freeでは利用できません。</p>
<h2 id="%E8%87%AA%E5%8B%95%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%82%92%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%99%E3%82%8B" data-line="24" class="code-line"><a class="header-anchor-link" href="#%E8%87%AA%E5%8B%95%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%82%92%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%99%E3%82%8B" aria-hidden="true"></a> 自動レビューを有効にする</h2>
<p data-line="26" class="code-line">PRを作成するたびにCopilotが自動でレビューするように設定します。設定方法は2つあります。</p>
<h3 id="%E5%80%8B%E4%BA%BA%E8%A8%AD%E5%AE%9A%E3%81%A7%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88" data-line="28" class="code-line"><a class="header-anchor-link" href="#%E5%80%8B%E4%BA%BA%E8%A8%AD%E5%AE%9A%E3%81%A7%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88" aria-hidden="true"></a> 個人設定で有効にする場合</h3>
<p data-line="30" class="code-line">Copilot Pro/Pro+プランの場合は個人設定から有効にできます。</p>
<ol data-line="32" class="code-line">
<li data-line="32" class="code-line">GitHubの右上にあるプロフィール画像をクリック</li>
</ol>
<p data-line="34" class="code-line"><img src="https://i.gyazo.com/0286656eb20b22b3428353c7fe8db9f4.png" alt="Image from Gyazo" /></p>
<ol start="2" data-line="36" class="code-line">
<li data-line="36" class="code-line"><strong>Copilot settings</strong> を選択</li>
<li data-line="37" class="code-line"><strong>Automatic Copilot code review</strong> を <strong>Enabled</strong> に変更</li>
</ol>
<p data-line="39" class="code-line"><img src="https://i.gyazo.com/9a791a2c5acea067c7d253a46897319c.png" alt="Image from Gyazo" /></p>
<h3 id="rulesets%E3%81%A7%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88" data-line="41" class="code-line"><a class="header-anchor-link" href="#rulesets%E3%81%A7%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%99%E3%82%8B%E5%A0%B4%E5%90%88" aria-hidden="true"></a> Rulesetsで有効にする場合</h3>
<p data-line="43" class="code-line">リポジトリや組織全体で統一的に設定したい場合はRulesetsを使います。</p>
<p data-line="45" class="code-line">リポジトリの設定画面を開きます。</p>
<div class="code-block-container"><pre><code class="code-line" data-line="47">Settings → Rules → Rulesets → New ruleset → New branch ruleset
</code></pre></div><p data-line="51" class="code-line">以下の項目を設定します。</p>
<ul data-line="53" class="code-line">
<li data-line="53" class="code-line"><strong>Ruleset name</strong> ：任意の名前（例：copilot-review）</li>
<li data-line="54" class="code-line"><strong>Enforcement Status</strong> ： <strong>Active</strong> を選択</li>
<li data-line="55" class="code-line"><strong>Target branches</strong> ：対象ブランチを指定（Include default branchなど）</li>
</ul>
<p data-line="57" class="code-line"><strong>Branch rules</strong> セクションで以下をチェックします。</p>
<ul data-line="59" class="code-line">
<li data-line="59" class="code-line"><strong>Automatically request Copilot code review</strong> ：自動レビューを有効化</li>
</ul>
<p data-line="61" class="code-line">オプションとして以下も設定できます。</p>
<ul data-line="63" class="code-line">
<li data-line="63" class="code-line"><strong>Review new pushes</strong> ：プッシュのたびにレビュー実行</li>
<li data-line="64" class="code-line"><strong>Review draft pull requests</strong> ：ドラフトPR段階からレビュー実行</li>
</ul>
<p data-line="66" class="code-line">最後に <strong>Create</strong> をクリックして完了です。</p>
<h2 id="%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%81%AE%E8%A6%B3%E7%82%B9" data-line="68" class="code-line"><a class="header-anchor-link" href="#%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%81%AE%E8%A6%B3%E7%82%B9" aria-hidden="true"></a> レビューの観点</h2>
<p data-line="70" class="code-line">Copilot code reviewは以下の観点からコードを分析します。</p>
<ul data-line="72" class="code-line">
<li data-line="72" class="code-line">コード構造の最適化</li>
<li data-line="73" class="code-line">重複コードの検出（DRY原則）</li>
<li data-line="74" class="code-line">セキュリティの脆弱性（CodeQL連携時）</li>
</ul>
<p data-line="76" class="code-line">静的解析ツールとの連携も可能です。CodeQLはデフォルトで有効になっていますが、ESLintやPMDは手動で有効にする必要があります。</p>
<h2 id="%E6%B3%A8%E6%84%8F%E7%82%B9" data-line="78" class="code-line"><a class="header-anchor-link" href="#%E6%B3%A8%E6%84%8F%E7%82%B9" aria-hidden="true"></a> 注意点</h2>
<p data-line="80" class="code-line">レビューリクエストごとに月間クォータを1件消費します。自動レビューの場合、クォータはPR作成者に適用されます。月間クォータに達すると、リセットされるまで利用できなくなります。</p>
<p data-line="82" class="code-line">組織でCopilot Business/Enterpriseを契約している場合、ライセンスを持っていないメンバーもコードレビュー機能を使えるようにできます。ただし、追加使用料（Overage usage）として課金されるため、管理者がポリシーで明示的に有効化する必要があります。</p>


GitHub Copilot code reviewでPRを自動レビューする