2012-07-31 37 views
3

我想在開發代碼的同時爲我的項目管理GitHub wiki。例如:由主版本庫管理的GitHub wiki

分行

  • 主(穩定版)
    • 發展(下一個版本的開發)
    • 其他...(其它可能的開發/功能分支)

理想情況下,我希望wiki包含在子文件夾中(例如/ wiki)。然後,當我對代碼進行更改時,我也可以同時更新wiki(代碼+文檔更改)。這也意味着我所有的開發代碼和文檔都將在「開發」分支中獨立,直到我與「主」分支合併爲止。希望即使通過手動過程,GitHub wiki也會在與主服務器合併後進行更新,以反映更改。

我已經看過Git的子模塊功能,但從我所瞭解的通常指向單個修訂版。我想以某種方式遵循我的代碼開發,所以分支和合並將正常工作。

+0

有沒有得到它的工作?我有一個[類似的問題](http://stackoverflow.com/q/17021163/819272)與BitBucket。我擔心,所有帶有wiki子目錄的解決方案最終都是註定要失敗的。應該修正的是,GitHub/BitBucket Wiki是指向主要回購庫的特定提交的指針,而不是單獨的回購站。 – TemplateRex 2013-06-10 11:37:45

+0

從來沒有得到這個工作,並轉移到其他東西,因爲不需要進一步調查。有一次,我使用腳本在構建我的項目時將我的wiki更改部署到github,這表明我不必擔心分支和子模塊等等。 – 2013-07-05 09:34:34

回答

1

如「True nature of submodules」中所述,您可以在子模塊內進行修改和更新,只要您還提交父回購以記錄「wiki」子回購的新狀態。

+0

謝謝,這說明它比我發現的其他信息。它如何處理分支/合併?我可以在存儲庫的「開發」分支中擁有wiki的「開發」分支,然後輕鬆應對合並以掌握? – 2012-08-01 19:43:54

+0

@MisterDai每個回購(父回購和子回購(s)回購)都有自己的一套分支,獨立於一個回購到另一個回購。您可以隨時在子模塊中更改分支,前提是您花時間回到父回購並提交,以便記錄子模塊的新狀態。 – VonC 2012-08-01 21:45:53

1

如果您打算在本地機器上使用Gollum來顯示和處理您的GitHub wiki(您可能應該),那麼如果使用子模塊,則會遇到麻煩。

Gollum希望對本地Git存儲庫(但不推送)進行本地提交,但在子模塊中.git實際上是包含本地存儲庫的文件,而不是真正的Git存儲庫。這會導致Gollum破裂。

子模塊也有問題,版本不耦合到父存儲庫,並且它們不完全分離。每次更改文檔時,讓源代碼庫希望推送新的wiki版本號(但不包括Wiki內容)是一件令人討厭的事情。

我使用的解決方案僅僅是將wiki庫克隆到主項目目錄內的一個目錄中,並將其添加到.gitignore。通過使用跨項目目錄的一致名稱(例如github-wiki),可以最大限度地降低維基不會在.gitignore並偶然上載到主存儲庫的機會。

爲了保持一致性,他的方法也適用於GitHub頁面,雖然它沒有必要,因爲他們沒有經歷Gollum的問題。