GitHub ActionsでPRにコメントを追加する方法

この記事では、GitHub Actionsを利用してプルリクエスト（以下、PR）に自動的にコメントを追加する方法を解説します。この技術を活用すると、コードレビューの効率化や、特定の条件で自動的にコメントを追加することが可能になります。

1. GitHub Actionsの基礎知識

GitHub Actionsは、GitHub上で自動化されたワークフローを実行できるサービスです。ワークフローは、特定のイベント（例えば、PRの作成やマージなど）が発生した際にトリガーされ、一連の処理を実行します。この処理には、コードのビルドやテスト、PRにコメントを追加することなどが含まれます。

2. PRにコメントを追加するワークフローの作成

以下は、PRにコメントを追加するワークフローの作成手順です。

2.1 ワークフローの定義

.github/workflowsディレクトリに、新しいファイル（例えば、comment.yml）を作成し、以下の内容を記述します。

name: Comment on PR

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  comment:
    runs-on: ubuntu-latest
    steps:
    - name: Comment on PR
      uses: actions/github-script@v4
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        script: |
          const { issue: { number: issue_number }, repo: { owner, repo } } = context;
          await github.issues.createComment({ issue_number, owner, repo, body: '自動コメントの例' });

このワークフローは、pull_requestイベントが発生した際にトリガーされ、actions/github-scriptアクションを使用して、PRにコメントを追加します。GITHUB_TOKENは、GitHubが自動的に提供するシークレットトークンで、リポジトリに対するアクセス権を持っています。

2.2 プロンプト例と設定の調整ポイント

• コメントの内容をカスタマイズするには、以下の部分を編集します。

body: '自動コメントの例'

• コメントを追加する条件を変更するには、以下の部分を編集します。

on:
  pull_request:
    types: [opened, synchronize, reopened]

上記の例では、PRが作成された際（opened）、または、既存のPRに新しいコミットがプッシュされた際（synchronize）、または、PRが再開された際（reopened）にコメントを追加します。これらの条件を変更することで、コメントを追加するタイミングを調整することができます。

3. 法的・倫理的な注意点と安全な運用方法

• GitHub Actionsを利用してPRにコメントを追加する際、以下の点に注意してください。
  • コメントの内容は、他のリポジトリメンバーや、外部のコントリビューターに見られる可能性があります。機密情報や個人情報を露出する可能性を避けるため、コメントの内容を慎重に選択してください。
  • GitHub Actionsは、リポジトリに対するアクセス権を持つユーザーのみが実行することができます。しかし、リポジトリにアクセスできるユーザーが不特定多数の場合、不正なアクセスや悪意のある行為の可能性を考慮してください。ワークフローのセキュリティを強化するため、必要な権限のみを持つユーザーにアクセス権を与えるようにしてください。

4. FAQ

Q1: PRにコメントを追加する際に、特定の条件を満たす場合にのみコメントを追加したい場合はどうすればいいですか？

A1: 条件を満たすかどうかを判定するために、ワークフロー内で任意の処理を実行し、条件に応じてコメントを追加することができます。例えば、特定のファイルが変更された場合にのみコメントを追加するには、以下のような手順

で実現することができます。

- name: Check if file is changed
  id: changed-files
  uses: peter-evans/find-changed-files@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    file-relative-path: 'path/to/file'

- name: Comment on PR
  if: steps.changed-files.outputs.files == 'path/to/file'
  uses: actions/github-script@v4
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    script: |
      // コメントを追加する処理

Q2: PRにコメントを追加する際に、特定のラベルを付与する場合にのみコメントを追加したい場合はどうすればいいですか？

A2: ラベルを付与する際に、ワークフロー内でラベルを確認し、条件に応じてコメントを追加することができます。以下は、特定のラベルが付与された場合にのみコメントを追加する例です。

- name: Check if label is present
  id: label-check
  run: |
    LABEL_NAME="label-name"
    LABELS=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels" | jq -r '.[] | .name')
    if echo "$LABELS" | grep -q "$LABEL_NAME"; then
      echo "::set-output name=present::true"
    else
      echo "::set-output name=present::false"
    fi

- name: Comment on PR
  if: steps.label-check.outputs.present == 'true'
  uses: actions/github-script@v4
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    script: |
      // コメントを追加する処理

Q3: PRにコメントを追加する際に、特定のファイルが変更された場合にのみコメントを追加したい場合はどうすればいいですか？

A3: この質問は、Q1の回答に似ていますが、条件を満たすファイルを確認するために、別のアクションを使用しています。以下は、特定のファイルが変更された場合にのみコメントを追加する例です。

- name: Check if file is changed
  id: changed-files
  uses: peter-evans/find-changed-files@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    file-relative-path: 'path/to/file'

- name: Comment on PR
  if: steps.changed-files.outputs.files == 'path/to/file'
  uses: actions/github-script@v4
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    script: |
      // コメントを追加する処理

この例では、peter-evans/find-changed-filesアクションを使用して、変更されたファイルを確認しています。このアクションは、GitHubのAPIを使用して、特定のファイルが変更されたかどうかを判定します。このアクションの出力を使用して、条件に応じてコメントを追加することができます。

---

本記事はAI技術の安全な活用を推奨します。関連法規を遵守のうえご利用ください。