GitHub ActionsでPRマージ時にワークフローを起動させる方法

はじめに

GitHub Actionsでワークフローを起動させる際、プルリクエストのマージに対応するイベントがなく、別の記述を追加する必要があるのでまとめます。

コード

結論としては、ワークフローファイルのonとjobsがそれぞれ下記のような形になります。

on: 
  pull_request:
    types: 
      - closed

jobs:
  if_merged:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
    - run: |
        echo The PR was merged

重要なのは以下の2つです。

マージされた時にワークフローをトリガーするための記述です。

types: 
  - closed

trueでジョブを実行、falseでジョブをスキップします。

if: github.event.pull_request.merged == true

参考情報