From b8bc84b50453bb457ea617fd97d24c4e5afecd5b Mon Sep 17 00:00:00 2001
From: Christopher Sexton <csexton@users.noreply.github.com>
Date: Fri, 17 Jan 2020 11:24:32 -0500
Subject: [PATCH] Handle submodules with SSH URLs

This is just a documentation change, explaining how to fix submodules
that are configured to use SSH URLs instead of HTTPS URLs. Spent a while
banging my head on the wall and hope this saves someone else the pain.

This is helpful for teams that use the SSH protocol for local
development so don't want to change the mechanism that pulls in the
submodules. Using `insteadOf` seems a bit nicer than than setting up a
deploy keypair.
---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 82d3494..38261da 100644
--- a/README.md
+++ b/README.md
@@ -180,6 +180,7 @@ jobs:
 - name: Checkout submodules
   shell: bash
   run: |
+    git config --global url."https://github.com/".insteadOf "git@github.com:"
     auth_header="$(git config --local --get http.https://github.com/.extraheader)"
     git submodule sync --recursive
     git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1