由主存储库管理的 GitHub wiki答案

【问题标题】：GitHub wiki managed by the main repository由主存储库管理的 GitHub wiki
【发布时间】：2012-07-31 07:16:59
【问题描述】：

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

分支机构

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

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

我查看了 Git 的子模块功能，但据我了解，这通常指向单个修订版。我想以某种方式跟踪我的代码开发，以便分支和合并可以正常工作。

【问题讨论】：

有没有让它工作？我有一个带有 BitBucket 的similar problem。我担心，所有带有 wiki subrepo 的解决方案最终都注定要失败。应该修复的是 GitHub/BitBucket Wiki 是指向主仓库上特定提交的指针，而不是单独的仓库。
从来没有得到这个工作并转移到别的东西，因为所以不需要进一步调查。有一次，我在构建项目时使用脚本将我的 wiki 更改部署到 github，效果很好，这意味着我不必担心分支和子模块等......

标签： github repository wiki

【解决方案1】：

如“True nature of submodules”中所述，您可以在子模块中进行修改和更新，只要您同时提交父 repo 以记录您的“wiki”子 repo 的新状态。

【讨论】：

谢谢，这比我找到的其他信息解释得更好。它如何应对分支/合并？我可以在存储库的“开发”分支中拥有 wiki 的“开发”分支，然后轻松应对合并到 master 吗？
@MisterDai 每个仓库（父仓库和子模块仓库）都有自己的一组分支，独立于一个仓库到另一个仓库。您可以随时更改子模块中的分支，只要您花时间返回父 repo 并提交，以记录子模块的新状态。

【解决方案2】：

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

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

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

我使用的解决方案只是将 wiki 存储库克隆到主项目目录中的一个目录中，并将其添加到 .gitignore。通过为跨项目的目录使用一致的名称（例如 github-wiki），将 wiki 不在 .gitignore 中并意外上传到主存储库的可能性降到最低。

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

【讨论】：