生成提交文檔

Question

作爲git commit工作流程的一部分自動生成ruby文檔的最佳做法是什麼？我們希望在提交合併到主機時自動生成新的文檔。

Answer 1

使用Git鉤子。

如果您希望它在客戶端運行，請使用提交後掛鉤。實質上，註冊一個鉤子（通過將其存儲在.git/hooks中）使Git調用在每個成功的git commit之後提供的任意腳本。然後，您的腳本可以調用RDoc或YARD將文檔生成到某個輸出目錄（當然，在您的源代碼庫之外）。

或者，您可以讓它運行在託管您的Git倉庫的服務器上，使用收貨後掛鉤。這將在您推送到服務器的回購後運行。例如，您可以使用它自動將新文檔上傳到您項目的Web服務器上的/docs/dev/。

有關詳細說明，請參閱the chapter on hooks in the Git manual。