如何修复 Github Travis CI 构建中 git 子模块更新的权限被拒绝（公钥）错误？

Question

我无法更新 git 子模块，出现错误：

$ git submodule init
Submodule 'build/html' (git@github.com:quadroid/clonejs.git) registered for path 'build/html'
...
$ git submodule update
Cloning into 'build/html'...
Warning: Permanently added 'github.com,207.97.227.239' (RSA) to the list of known hosts.
Permission denied (publickey).
fatal: Could not read from remote repository.

但是当我在本地执行相同的任务时，一切正常。

如何解决这个问题，以便 Travis CI 构建通过，并且我仍然可以单击 repo 中的子模块以定向到它？

Answer 1

我建议对子模块使用https 方案，因为这样您就可以拉取 Travis 并在本地推送：https://github.com/quadroid/clonejs.git。

Answer 2

这可以（谢天谢地）通过在 Travis 上即时修改 .gitmodules 文件来轻松解决，以便在初始化子模块之前将 SSH URL 替换为公共 URL。为此，请将以下内容添加到 .travis.yml：

# Handle git submodules yourself
git:
    submodules: false
# Use sed to replace the SSH URL with the public URL, then initialize submodules
before_install:
    - sed -i 's/git@github.com:/https:\/\/github.com\//' .gitmodules
    - git submodule update --init --recursive

感谢 Michael Iedema 提供的 gist，我从中得出了这个解决方案。

如果您的子模块是私有存储库，它应该可以在 https URL 中包含凭据，我建议为此目的创建一个具有受限权限的GitHub access token：

# Replace <user> and <token> with your GitHub username and access token respectively
- sed -i 's/git@github.com:/https:\/\/<user>:<token>@github.com\//' .gitmodules

Answer 3

Travis 现在支持使用 ssh 访问子模块，这是迄今为止最简单的解决方案。您只需要将您的 ssh 密钥（或专用 CI 用户的 ssh 密钥）与您正在构建的 Github 项目相关联，如 documentation for private dependencies 中所述。

$ travis sshkey --upload ~/.ssh/id_rsa -r myorg/main

请注意，Travis 建议创建一个专用用户，这样您就不必使用自己的 ssh 密钥。

Answer 4

您收到此错误是因为您通过 ssh-urls 指定了子模块。要从 travis-ci 环境进行 ssh 访问，您需要 configure a key。

或者，你可以只为你的 git 子模块使用相对 URL，因为你的项目和你的子模块都在 Github 上可用。

Git 根据ORIGIN 解析相对网址。

例子：

使用您的 .gitmodules 中的前 2 个条目：

[submodule "lib/es5-shim"]
        path = lib/es5-shim
        url = git@github.com:kriskowal/es5-shim.git
[submodule "build/html"]
        path = build/html
        url = git@github.com:quadroid/clonejs.git

替换为相对 URL：

[submodule "lib/es5-shim"]
        path = lib/es5-shim
        url = ../../kriskowal/es5-shim.git
[submodule "build/html"]
        path = build/html
        url = ../clonejs.git

然后当克隆时 - 比如说 - 通过 https 来源设置如下：

$ git clone https://github.com/quadroid/clonejs.git
$ cd clonejs
$ git remote -v
origin  https://github.com/quadroid/clonejs.git (fetch)
origin  https://github.com/quadroid/clonejs.git (push)

通过 ssh 克隆时：

$ git clone git@github.com:quadroid/clonejs.git
$ cd clonejs
$ git remote -v                                
origin  git@github.com:quadroid/clonejs.git (fetch)
origin  git@github.com:quadroid/clonejs.git (push)

使用相对 url，通常的子模块序列独立于来源：

$ git submodule init
$ git submodule update

Answer 5

您也可以通过git 直接操作您的 .gitmodules 文件。 （灵感来自this answer）。

git config --file=.gitmodules submodule.SUBMODULE_PATH.url https://github.com/ORG/REPO.git