生成提交文档

Question

作为git提交工作流程的一部分，自动生成ruby文档的最佳实践是什么？每当提交合并到master中时，我们都会自动生成新的文档。

Answer 1

使用Git钩子。

如果您希望它在客户端运行，请使用提交后挂钩。本质上，注册一个钩子（通过将其存储在.git/hooks中）使得Git调用您在每次成功git commit之后提供的任意脚本。然后，您的脚本可以调用RDoc或YARD将docs生成到某个输出目录（当然，在源代码库之外）。

或者，您可以使用 post-receive 挂钩在托管Git仓库的服务器上运行它。这将在您推送到服务器的回购后运行。例如，您可以使用此功能自动将新文档上传到项目的Web服务器上的/docs/dev/。

有关详细说明，请参阅the chapter on hooks in the Git manual。