GITHUB_REF_NAMEとは?

GITHUB_REF_NAMEは、実行をトリガーしたbranchまたはtagの短く分かりやすい名前です。

GITHUB_REFが完全なrefであるのに対し、GITHUB_REF_NAMEはプレフィックスを取り除き、main、feature/login、v1.2.0だけを返します - 名前付けや条件分岐に通常欲しいものです。

よくある用途

• ref名がmainのときだけdeployする
• tagにちなんでreleaseに名前を付ける
• preview URL用にbranchをslug化する

例

branch名を条件にdeployのjobを制御する。

if: ${{ github.ref_name == 'main' }}

重要なポイント

• GITHUB_REF_NAMEは短いbranch/tag名です。
• refs/headsやrefs/tagsのプレフィックスを取り除きます。
• 条件分岐や名前付けに最適です。

関連ガイド