4

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

分支机构

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

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

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

4

2 回答 2

1

如“子模块的真实性质”中所述，您可以在子模块中进行修改和更新，只要您还提交父 repo 以记录您的“ wiki”子 repo 的新状态。

于 2012-07-31T08:31:24.853 回答
1

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

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

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

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

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

于 2013-05-29T05:14:08.800 回答