如何配置GitHub子模块以兼容SSH与HTTPS两种访问方式？

这是目前最简洁且无需用户额外操作的方法，GitHub的Git服务会自动根据主仓库的克隆协议，把相对URL转换为对应的SSH或HTTPS地址，完美适配团队成员和普通贡献者的不同需求。

1. 新增子模块时直接用相对路径 #

当你添加子模块时，不要填写完整的SSH/HTTPS URL，而是用基于主仓库的相对路径：

# 假设主仓库是 https://github.com/your-org/main-repo.git
# 子模块是同组织下的 your-org/submodule-repo.git
git submodule add ../your-org/submodule-repo.git path/to/submodule

如果子模块在其他组织下，比如 another-org/submodule-repo.git，就用多级相对路径：

git submodule add ../../another-org/submodule-repo.git path/to/submodule

2. 修改已存在的子模块URL #

如果已经添加了子模块，只要编辑项目根目录的 .gitmodules 文件，把 url 字段改成相对路径即可：

修改前： #

[submodule "my-submodule"]
    path = my-submodule
    url = git@github.com:your-org/submodule-repo.git

修改后： #

[submodule "my-submodule"]
    path = my-submodule
    url = ../your-org/submodule-repo.git

保存文件后，运行以下命令同步子模块的远程地址，然后提交修改：

git submodule sync
git add .gitmodules
git commit -m "Update submodule URL to relative path for cross-protocol compatibility"

为什么这个方法管用？ #

当用户用SSH克隆主仓库时（git@github.com:your-org/main-repo.git），GitHub会自动把相对URL解析为SSH格式的子模块地址；如果用户用HTTPS克隆（https://github.com/your-org/main-repo.git），相对URL会被解析为HTTPS格式。两边都不需要手动修改子模块配置，完全自动适配。

备选方案：让用户手动切换子模块协议（不推荐） #

如果因为某些原因不能用相对URL，团队成员可以在克隆主仓库后，批量修改所有子模块的远程地址为SSH：

git submodule foreach git remote set-url origin git@github.com:your-org/submodule-repo.git

普通用户则不需要做任何修改，默认用HTTPS拉取。但这个方法需要团队成员手动执行命令，不如相对URL省心。

内容的提问来源于stack exchange，提问作者Yuri Astrakhan