From 77904fd4316d60fc138fe2b8286ca220f763853e Mon Sep 17 00:00:00 2001
From: Christopher Sexton <csexton@users.noreply.github.com>
Date: Thu, 13 Feb 2020 14:44:37 -0500
Subject: [PATCH] Handle submodules with SSH URLs (#140)

* 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.

* SSH submodules

Co-authored-by: Chris Patterson <chrispat@github.com>
---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 82d3494..54b3429 100644
--- a/README.md
+++ b/README.md
@@ -180,6 +180,8 @@ jobs:
 - name: Checkout submodules
   shell: bash
   run: |
+    # If your submodules are configured to use SSH instead of HTTPS please uncomment the following line
+    # 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