我想开始使用 GitHub Pages对于我的项目的网站。这只需要一个名为 gh-pages 的分支(子树)在 repo 协议(protocol)中，并提供其内容。问题是网站的一部分(手册、变更日志、下载页面...)是由构建系统自动生成的，所以我想找到将这些更改提交到 gh-pages 的最佳方法。分支，而主 repo 仍在 master (或任何地方)。

致力于 gh-pages分支，我可以编写一个脚本，将 repo 克隆到一个临时目录中，进行修改，提交它们，然后将它们推回主 repo。但这听起来像是一个容易出错的过程，所以我希望有更简单的方法。

一位 friend 建议我可以添加 gh-pages分支作为主存储库的子模块。我做了一个小实验，但效果不佳:

$ git init main
Initialized empty Git repository in /tmp/main/.git/
$ cd main
$ touch main.txt
$ git add .
$ git commit -m'Initial commit in main branch.'
[master (root-commit) 1c52a4e] Initial commit in main branch.
 0 files changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 main.txt
$ git symbolic-ref HEAD refs/heads/gh-pages
$ rm .git/index
$ git clean -fdx
Removing main.txt
$ touch index.html
$ git add .
$ git commit -m'Initial commit in website branch.'
[gh-pages (root-commit) 94b10f2] Initial commit in website branch.
 0 files changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 index.html
$ git checkout master
Switched to branch 'master'
$ git submodule add -b gh-pages . gh-pages
repo URL: '.' must be absolute or begin with ./|../
$ git submodule add -b gh-pages ./ gh-pages
remote (origin) does not have a url defined in .git/config

我是子模块的新手；当然，我读过一些书，但我不明白这种行为。为什么它需要 origin偏僻的？理想情况下，我希望子模块始终引用它所在的存储库，因此它不应引用 origin或任何其他 Remote 。如果有人克隆 repo 并运行 git submodule init ; git submodule update , 它应该理想地从新克隆的 repo 中提取。

是否可以将 repo 添加为自身的子模块？这是可取的吗？有什么我需要注意的陷阱吗？有没有更好的方法来实现我想要的？

最佳答案

在这种情况下，行为似乎是 git 试图将原始存储库的来源设置为子模块的来源。 git submodule 手册页证实了这一点，上面写着 [my emphasis]:

<repository> is the URL of the new submodule’s origin repository. This may be either an absolute URL, or (if it begins with ./ or ../), the location relative to the superproject’s origin repository.

对我来说似乎不错的解决方法是执行以下操作:

# Define origin to be the absolute path to this repository - we'll remove
# this later:
$ cd /tmp/main/
$ git remote add origin /tmp/main/

# Now add the submodule:
$ git submodule add -b gh-pages ./ gh-pages
Initialized empty Git repository in /tmp/main/gh-pages/.git/
Branch gh-pages set up to track remote branch gh-pages from origin.

# Now .gitmodules looks sensible:
$ cat .gitmodules 
[submodule "gh-pages"]
    path = gh-pages
    url = ./

# However, the origin for the submodule isn't what we want:
$ cd gh-pages
$ git remote -v
origin  /tmp/main/ (fetch)
origin  /tmp/main/ (push)

# So remove it and add the right origin (just ".."):
$ git remote rm origin
$ git remote add origin ..

# Change back to the main repository and commit:
$ cd ..
$ git commit -m "Added the gh-pages branch as a submodule of this repository"
[master 6849d53] Added the gh-pages branch as a submodule of this repository
 2 files changed, 4 insertions(+), 0 deletions(-)
 create mode 100644 .gitmodules
 create mode 160000 gh-pages

这似乎工作正常 - 如果我切换到另一个目录并执行:

$ cd /var/tmp
$ git clone --recursive /tmp/main/

...子模块已正确更新和初始化。 (更新:尽管正如您在下面的评论中指出的那样，子模块中的 origin 将设置为您从中克隆的 URL 而不是 ..)

至于这是否是个好主意:我曾参与过一个项目，该项目过去使用了类似的设置，但后来放弃了它。然而，这样做的原因是 (a) 主存储库中的替代分支巨大并且使存储库膨胀，即使对于不需要子模块的人也是如此，以及 (b) 它造成了困惑对于不确定发生了什么的人。

但是，对于您的用例，我认为这是一个相当巧妙的解决方案 :)

关于git - 如何将 git repo 添加为自身的子模块？ (或 : How to generate GitHub Pages programmatically? )，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/5296236/