PR のラベルの追加をトリガーに GitHub Actions を実行する

やりたいこと

そのため他のトリガーで CI を実行できないか検討したところ、ラベルの追加がちょうど良さそうだったのでこれで実装することにした。

参考

試したけどやめたこと

PR に CI のステータスが反映されない, 最新のコミットにチェックマークがつかない

などの不便があったので、やめることにした。

試したい方は以下の Discussion を参考にしてほしい。

作成したワークフロー

code: .github/workflows/ci.yml

name: CI

on:

pull_request:

- labeled

jobs:

preprocess:

runs-on: ubuntu-latest

if: github.event.label.name == 'needs CI'

steps:

# .git/ がないと GitHub CLI がリポジトリを判別できない

# checkout せずに環境変数を設定すればどうにかできそうではある

- name: Checkout repo

uses: actions/checkout@v4

with:

ref: ${{ github.head_ref }}

- name: Remove triggered labels

if: github.event.label

env:

GH_TOKEN: ${{ github.token }}

run: |

gh pr edit ${{ github.event.number }} --remove-label "${{ github.event.labal.name }}"

test:

runs-on: ubuntu-latest

needs: preprocess

steps:

- name: Checkout repo

uses: actions/checkout@v4

with:

ref: ${{ github.head_ref }}

- ...

PR にワークフローの実行状況も反映されるし、最後のコミットにチェックマークもつく。いい感じ。

あとがき