Skip to content
Latchkey

GITHUB_REFとは?

GITHUB_REFは、workflowをトリガーした完全なGit refで、refs/heads/mainやrefs/tags/v1.2.0のような値です。

GITHUB_REFは、どのbranchまたはtagがbuildされているかをworkflowに伝えます。完全修飾のrefであるため、短い名前だけが欲しい場合はGITHUB_REF_NAMEを使いたくなることが多いでしょう。

形式

  • branchへのpush: refs/heads/<branch>
  • tagへのpush: refs/tags/<tag>
  • pull request: refs/pull/<number>/merge

短い名前を取得する

GITHUB_REFを自分でparseするのではなく、GITHUB_REF_NAME(例: mainv1.2.0)を使いましょう。

重要なポイント

  • GITHUB_REFは実行をトリガーした完全なrefです。
  • refs/heads、refs/tags、またはrefs/pullのプレフィックスが付きます。
  • 短いbranch/tag名にはGITHUB_REF_NAMEを使いましょう。

関連ガイド