GitHub Actionsのdocsに出てくる $default-branch という記述について

今更ながらGitHub Actionsを使い始めることにした。
まずは小さめのプロジェクトに導入してみようと思い、最近作成した img2amp-img という、imgタグをamp-imgタグに変換するnpmツールのリポジトリにGitHub Actionsを設定してみることにした。

これはNode.jsのツールのため、下記のドキュメントを読みながら .yml ファイルを作成していたが、そのときに $default-branch という記述が出てきて、これはなんだろう？と思ったのが、このポストを書くことになったきっかけである。

Node.js のビルドとテスト - GitHub Docs

最初、GitHub上の Default branch を参照する変数的なものかと思ったが、そのままpushしても、CIは動いていないようだった。
これは間違っていそうだ...と思い、少し調べてみると、下記の記述を見つけた。

stackoverflow.com

どうやら、これはworkflow template用の記述であり、実際にworkflowを記載するときには利用しない記述のようだ。

$default-branch で記述していた箇所を下記のように修正して、再度 push することで、すぐにGitHub ActionsのCIが動き出すのを確認した。

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -2,9 +2,9 @@ name: Test

 on:
   push:
-    branches: [ $default-branch ]
+    branches: [ main ]
   pull_request:
-    branches: [ $default-branch ]
+    branches: [ main ]

以上、ちょっとした備忘録でした。