Netlifyでsubmoduleのgit cloneに失敗する

背景

privateリポジトリをsubmoduleとしてaddした状態で、Netlifyに連携している場合のお話です。

submoduleを追加したリポジトリがNetlify上でcloneに失敗する現象が発生しました。

Error checking out submodules: Submodule <Repository名> ...
...
Host key verification failed.

どうやらアクセス権が無いようです。
そりゃそうですよね。Netlifyに紐づけているリポジトリは1つのみなので、他のprivateリポジトリを除くことはできないのです。

解決方法

submodule対象のGitHubリポジトリの
https://github.com/<owner name>/<repository name>/settings/keys に
Netlifyのダッシュボードで出力したDeploy Keyを登録すればOKです。

NetlifyのダッシュボードのDeploy Keyが発行できる画面

その他

Netlifyのsubmoduleに失敗する件を調査している時にこの記事を見かけましたが、
このURLに変更しているとうまくクローンできなかったので念の為記載しておきます。
https://qiita.com/naokazuterada/items/7ecf8a3dcaa6c4b5313c