GitHub プル リクエスト

概要

Code Analysis は GitHub プル リクエストと 2 つの方法で連携します:

  • 違反をフラグ付けするプル リクエスト コメント: GitHub でコード レビューを行う際、Datadog は少なくとも 1 つのルール セットが適用されているリポジトリのプル リクエストに対し、静的解析 (SAST) の違反を自動で検出し、該当するコード行にインライン レビュー コメントとしてフラグ付けします。また、該当する場合はプル リクエスト内で直接適用できる修正案も提示されます。これは静的解析 (SAST) のみで利用可能です。

    プル リクエストにおける Code Analysis コメントの例

  • Datadog から直接問題を修正するプル リクエストを作成: Datadog が提案するコード修正に基づき、UI からセキュリティ脆弱性またはコード品質の問題を修正するプル リクエストを作成できます。これも静的解析 (SAST) のみで利用可能です。

    Code Analysis のワン クリック修正例

これらの機能を有効化するには、対象リポジトリに GitHub の必要な権限 (Read & Write) が付与されていることを確認してください。

GitHub プル リクエストで Code Analysis をセットアップする

Datadog Code Analysis を有効化する

Datadog Code Analysis を使用するには、セットアップ手順 に従って適切な構成ファイルをリポジトリに追加してください。

GitHub App を設定する

GitHub で Code Analysis を使用するには、次のいずれかを行ってください。

  • Datadog で GitHub App を新規作成します。
  • すでに Datadog で作成済みの GitHub App を更新します。

付与した権限によって、設定できる GitHub インテグレーション 機能が決まります。

GitHub App を作成してインストールする

  1. Datadog で Integrations > GitHub Applications > Add New GitHub Application に移動します。
  2. GitHub 組織名など、必要な情報を入力します。
  3. Select Features で Code Analysis: Pull Request Review Comments ボックスをチェックします。
  4. Edit Permissions で Pull Requests 権限が Read & Write になっていることを確認します。
  5. Create App in GitHub をクリックします。
  6. アプリ名を入力し、送信します。
  7. Install GitHub App をクリックします。
  8. アプリをインストールするリポジトリを選択し、Install & Authorize をクリックします。
GitHub App インストール画面

既存の GitHub App を更新する

  1. Datadog で Integrations > GitHub Applications に移動し、Code Analysis に使用する GitHub App を検索します。
    プル リクエストでの Static Analysis コメントの例
  2. Features タブの Code Analysis: Pull Request Comments セクションを確認し、追加の権限が必要かどうかを判断します。必要であれば Update permissions in GitHub をクリックしてアプリ設定を編集します。
  3. Repository permissions で Pull Requests アクセスを Read & Write に設定します。
    Pull Request Read & Write 権限のドロップ ダウン
  4. Subscribe to events の下で Pull request ボックスをチェックします。
    Pull Request Review Comment 権限のチェック ボックス

Code Analysis の PR コメントをリポジトリで有効化する

  1. Datadog で CI Settings > Code Analysis Settings に移動します。
  2. 対象リポジトリ名の横にあるトグル スイッチをクリックし、GitHub Comments を有効化します。下の例では demo-static-analysis-gates リポジトリでコメントが有効化されています。
Code Analysis のプル リクエスト コメントの例

注: スキャンの実行に GitHub Actions を使用している場合、push トリガーでアクションを起動しないとコメントは表示されません。

Datadog から直接脆弱性を修正する

GitHub App の Pull Requests 権限が Read & Write に設定されている場合、推奨修正が用意されているすべての静的解析結果でワン クリック修正が利用できます。

脆弱性を修正してプル リクエストを開く手順

  1. Code Analysis で対象の結果を表示します。
  2. サイド パネルで Fix Violation をクリックします。
  3. Open a Pull Request を選択します。
  4. プル リクエストのタイトルとコミット メッセージを入力します。
  5. Create PR をクリックします。

結果が検出されたブランチに直接コミットして修正することも可能です。

推奨修正をコミットする手順

  1. Code Analysis で対象の結果を表示します。
  2. サイド パネルで Fix Violation をクリックします。
  3. Commit to current branch をクリックします。

その他の参考資料

お役に立つドキュメント、リンクや記事:

GitHub インテグレーションについて学びましょうドキュメント more more Code Analysis について学びましょうドキュメント more more