GithubActionsで、使われ方に関わらず読めるブランチ名を取得する

はじめに

GithubActionsでは、Actionsの使われ方によってブランチ名の形式が変化する。
複数種類の使われ方をするReusable workflow内で、読めるブランチ名を取得できるようにしたかったので調査した。

やり方

${{ github.head_ref || github.ref_name }} でいい感じに取れる。

head_ref/ref_nameはプルリクエスト(PR)とそうじゃない場合で下記のようになる。

イベント	head_ref	ref_name
push		feature/hoge
workflow_disptach		feature/hoge
open PR	xx/merge	feature/hoge
push PR	xx/merge	feature/hoge

head_refを先に参照し、無い場合にref_nameを使うようにすれば、どちらの使われ方でも読めるブランチ名を取得できる。