生成提交文档

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。