はんなりと、ゆるやかに

アジャイル、スクラムが好きなITエンジニアが日々から学んだことをアウトプット

PullRequest が Open された時などに GitHubActions を実行する

GitHubActions で PullRequest への操作内容によってトリガーを切り替える方法を調べました。例えば、PullRequest が Open された時だけイベントを実行する方法です。結論から書くと、typesキーワードを記述することで可能です。

docs.github.com

GitHubActions の on は イベントごとにアクティビティタイプが指定できる

たとえば、PullRequest イベントは「assigned、unassigned、labeled・・・removed」の15個のアクティビティタイプが指定できる。PullRequest が作られたときにワークフローを実行したい場合は「opened」を指定する。

サンプル

name: TriggerTest

on:
  pull_request:
    types: [opened, reopened]
  pull_request_review:
    types: [edited]

jobs:
  test:
    runs-on: windows-2019
    steps:
      - name: PullRequest Type
        run: write-host "PullRequest Type"
        shell: pwsh

このサンプルはPullRequest が作成または再オープンされる場合、もしくはPullRequestのレビューのコメントが修正された場合にワークフローが実行されます。typesキーワードを変えることで、実行するトリガーを切り替えることもできます。submittedを指定すれば、PullRequestレビューが完了したタイミングでワークフローが実行されます。