[GitHub Actions] submoduleを最新の状態にする方法

2020/09/08

背景

下記のようにsubmoduleを指定しているリポジトリがある。

[submodule "_module"]
	path = _module
	url = https://github.com/example/test-module.git
	branch = develop

GitHub Actions のビルドの中で上記のsubmoduleの更新状況を含めてチェックアウトしたい。

方法

actions/checkoutだとsubmoduleまで最新化できなかったので、stepsにgit submodule update --remoteを追加した。

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Update Submodules
        run: git submodule update --remote

actions/checkout@v1だとsubmoduleのチェックアウトもできる情報があったが私の環境ではうまく動かなかった。