JavaScriptを有効にしてください

【GitHub】GitHub Actions プルリクエスト時に実行して結果に合わせてコメントを自動的に入れる

 ·  ☕ 1 分で読めます

【GitHub】GitHub Actions プルリクエスト時に実行してコメントを自動的に入れる

GitHub Actions プルリクエスト時に実行して結果に合わせてコメントを自動的に入れる

プルリクエスト時にコメントを入れる

プルリクエストを出した際に実行されます。
実行された結果によってプルリクエストにコメントを付けます。

 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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
name: Pull Request Check

on:
  pull_request:
    # プルリクエスト時の対象ブランチ
    branches:
      - main
      - develop

jobs:
  pr_check:
    name: Pull Request Check
    runs-on: ubuntu-latest
    steps:
    # テストなどを実行(exit 1 でわざとエラー扱いにする
    - name: Run Test
      run: exit 1

    # 成功
    - name: Success
      if: success()
      run: |
        echo '> **Note**' > comments
        echo '> OK' >> comments        

    # 失敗
    - name: PHPUnit Failed
      if: failure()
      run: |
        echo '> **Warning**' > comments
        echo '> NG' >> comments        

    # プルリクエストにコメントを入れる
    - name: Post comments
      if: always()
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        URL: ${{ github.event.pull_request.html_url }}
      run:
        gh pr comment -F ./comments "${URL}"

これを使用することでたとえばプルリクエスト時に自動でテストした結果をプルリクエストのコメントとして残すことが可能になります。

共有

こぴぺたん
著者
こぴぺたん
Copy & Paste Engineer