GitHub wiki由主存储库管理

Question

我想在开发代码的同时为我的项目管理GitHub wiki。例如：

分支机构

• master（稳定版）
  • 开发（下一版本的开发）
  • 其他......（可能的其他开发/功能分支）

理想情况下，我希望wiki包含在项目的子文件夹（例如/ wiki）中。然后，当我对代码进行更改时，我也可以同时更新wiki（代码+文档更改）。这也意味着我的所有开发代码和文档都将自包含在“develop”分支中，直到我与“master”分支合并为止。希望即使通过手动过程，GitHub wiki也会在与master合并后更新，以反映更改。

我已经看过Git的子模块功能，但据我所知，通常指向单个版本。我想以某种方式遵循我的代码开发，因此分支和合并将正常工作。

Answer 1

如＆＃34; True nature of submodules＆＃34;中所述，您可以在子模块中进行修改和更新，只要您同时提交父回复以记录＆＃的新状态34; wiki＆＃34;子回购。

Answer 2

如果您打算使用Gollum在本地计算机上显示和使用您的GitHub wiki（您可能应该这样做），那么如果您使用子模块，则会遇到麻烦。

Gollum希望对本地Git存储库进行本地提交（但不推送），但在子模块中.git实际上是一个包含本地存储库的文件，而不是真正的Git存储库。这导致咕噜破裂。

子模块还存在版本未耦合到父存储库的问题，并且它们未完全解耦。每次进行文档更改时，让源代码存储库想要推送新的wiki版本号（而不是wiki内容）是一件麻烦事。

我使用的解决方案只是将wiki存储库克隆到主项目目录中的目录中，并将其添加到.gitignore。通过在项目中使用一致的名称（例如github-wiki），可以最大限度地减少wiki不在.gitignore中并偶然上传到主存储库的机会。

为了保持一致性，他的方法也适用于GitHub页面，虽然没有必要，因为他们没有遇到Gollum的问题。