如何将现有的嵌套回购(已在子目录中签出)添加到父 Git 回购作为子模块?

How to add an existing nested repo (already checked out in a subdir) to a parent Git repo as a submodule?

如果我从我的工作(父)目录创建初始提交,但有独立签出 git 回购的子目录,会发生什么情况?

我只是做了 git add . 但是当带有嵌套 Git 存储库的子目录没有注册为父存储库的子模块时,这让我陷入了一个奇怪的境地。

那么:如何在父工作目录中的初始 "git add ." 之后继续进行,其中有子目录具有独立签出的嵌套 git 回购(为了获得正确的子模块)?

一个例子:

[imz@z super-existing-sub]$ ls 
c  sub
[imz@z super-existing-sub]$ ls -a sub/
.  ..  a  .git
[imz@z super-existing-sub]$ 

因此,super-existing-sub.

中已经有一个预先存在的 super-existing-sub/sub git 存储库

我在super-existing-sub运行之后:

$ git init
$ git add .

如何才能将预先存在的 Git 存储库正确注册为子模块?

现在,Git 以某种方式追踪到了它:

$ git status 
On branch master

Initial commit

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)

    new file:   c
    new file:   sub

$ 

但是git submodule有一些问题:

$ git submodule status 
No submodule mapping found in .gitmodules for path 'sub'
$ 

如何将其转换为正确的子模块?


我尝试按照答案(由 Victor 和我编写)中建议的方式进行,即 git submodule add URL subdir,但不幸的是,它中断了:

$ git submodule status
No submodule mapping found in .gitmodules for path 'wp-content/themes/liquorice'
$ git submodule add git@github.com:/nudgeme/Liquorice.git ./wp-content/themes/liquorice
'wp-content/themes/liquorice' already exists in the index
/sshx:kosmoplus:/home/kosmoplus/kosmoplus.ru.old $ git submodule status
No submodule mapping found in .gitmodules for path 'wp-content/themes/liquorice'
$ 

(我一直使用 git submodule init 让 git 识别它们,然后 git submodule update 将子模块实际克隆到工作目录中。但事实并非如此被问到。)

要从父目录创建新的 git 存储库,您需要在父目录上 运行 git init,然后 git submodule add ./path/to/submodule/

注意:子模块的路径必须是绝对路径,所以要在路径前加上./

或者,如果你想有一个好的外部 URL 作为子模块的 URL,你应该首先在 ./path/to/submodule/.git/config 中查找来源 URL,并且那么你应该可以

git submodule add URL ./path/to/submodule/

还没有在实践中尝试过,但是 git-submodule 的联机帮助页说:

If <path> does exist and is already a valid Git repository, then this is added to the changeset without cloning. This second form is provided to ease creating a new submodule from scratch, and presumes the user will later push the submodule to the given URL.

最后见 TL;DR。

让我们仔细阅读 git submodule <URL> <path> 的手册页,并注意以下注释:

If <path> does exist and is already a valid Git repository, then this is added to the changeset without cloning. This second form is provided to ease creating a new submodule from scratch, and presumes the user will later push the submodule to the given URL.

让我们尝试在像我们这样的情况下使用它(在您将父目录递归添加到新的父存储库之后,而已经存在嵌套的 Git 存储库)。

这个想法是,首先,在 ./path/to/submodule/.git/config 中查找来源 URL 以获得关于子模块的元信息的真实外部 URL,其次, 调用 git submodule <URL> <path> (根据手册页,这有望做我们想要的)。

让我们试试:

$ git submodule status
No submodule mapping found in .gitmodules for path 'wp-content/themes/liquorice'
$ git submodule add git@github.com:/nudgeme/Liquorice.git ./wp-content/themes/liquorice
'wp-content/themes/liquorice' already exists in the index
/sshx:kosmoplus:/home/kosmoplus/kosmoplus.ru.old $ git submodule status
No submodule mapping found in .gitmodules for path 'wp-content/themes/liquorice'
$ 

不幸的是,它坏了。

好吧,让我们考虑一下如何解决 "already exists in the index" 而不是我们想要的东西的问题...

...我们可以简单地将其从索引中删除!成功运行:

$ git submodule status
No submodule mapping found in .gitmodules for path 'wp-content/themes/liquorice'
$ git rm --cached ./wp-content/themes/liquorice
rm 'wp-content/themes/liquorice'
$ git submodule add git@github.com:/nudgeme/Liquorice.git ./wp-content/themes/liquorice
Adding existing repo at 'wp-content/themes/liquorice' to the index
$ git submodule status
 9733c0ab3e4207352e3f51d612f2a1c9c4a0b63a wp-content/themes/liquorice (liquorice2.1-1-g9733c0a)
$ 

TL;DR

  • 在子目录中查找来源 URL;
  • git rm --cached subdir
  • git submodule add URL subdir

这甚至可以做成一个简单的脚本来自动执行将现有嵌套存储库作为子模块添加到父级的任务,但我看不出增加东西的意义。在这个级别,只需学习基本的 Git 命令,并使用和组合它们!

基于 Victor Johnson 的回答,这里有一个 bash oneliner,用于一次添加一大堆子模块。

find . -name config | grep git/config | grep -v ProjectToExclude | grep -v AnotherProjectToExclude | xargs -n 1 -I % sh -c 'cat % | grep -m 1 url | sed "s/url = //g"; echo % | sed "s/.git\/config//g";' | xargs -n 2 echo git submodule add

详细解释

假设您有一个包含许多 git 存储库的文件夹,并且您希望父存储库将它们全部作为子模块:

path/to/one_repo
path/to/one_repo/.git/config
path/to/another_repo
path/to/another_repo/.git/config
(etc.)

而你想 运行 git submodule add ./path/to/submodule/ 为每一个。

1.这个 oneliner 为每个可能的子模块打印该命令。 运行 它作为一个干 - 运行 查看哪些文件夹有 .git/config 个包含 url = 的文件。请注意,它假定第一次出现的 url 是远程的 - 请确保您对结果进行了全面检查。

又是oneliner,说明:

find . -name config |                            # find all config files
    grep git/config |                            # include only those that have "git/config" in their path
    grep -v ProjectToExclude |                   # exclude config files with ProjectToExclude in their path
    grep -v AnotherProjectToExclude |            # ditto
    xargs -n 1 -I % sh -c '                      # one line at a time, execute the following commands, substituting the path for `%`
        cat % |                                  # print the config file contents
            grep -m 1 url |                      # take the first line that contains `url`
            sed "s/url = //g";                   # remove the "url = " part
        echo % |                                 # print the path to the config file
            sed "s/.git\/config//g";             # remove '.git/config' to keep only the project path
    ' |                                          # summary: print the remote url on every 2nd line; the path on every 2nd line 
    xargs -n 2 echo git submodule add            # take two lines at a time, print them with the command

请注意,您可以向管道添加任意数量的 grep -v ProjectToExclude 以排除这些文件夹 - 运行 oneliner 再次查看要执行的新命令列表,并注意 ProjectToExclude 已经不存在了。

这将打印出:

git submodule add https://github.com/username/one_repo.git path/to/one_repo
git submodule add git@otherdomain.com:another_repo.git path/to/another_repo
(etc.)

2。然后,真正执行它: 去掉命令末尾的 echo,所以最后一部分由

xargs -n 2 echo git submodule add

xargs -n 2 git submodule add

(不是回显命令,而是实际执行它。)

3。将其添加到 git。 您现在可以 运行 git status 查看您刚刚完成的操作。