作为 git 提交工作流程的一部分，自动生成 ruby 文档的最佳实践是什么？我们希望在提交合并到 master 时自动生成新文档。
问问题
914 次
1 回答
5
使用 Git 钩子。
如果您希望它在客户端运行，请使用提交后挂钩。从本质上讲，注册一个钩子（通过将其存储在 中.git/hooks）使 Git 调用您在每次成功后提供的任意脚本git commit。然后，您的脚本可以调用 RDoc 或 YARD 将文档生成到某个输出目录（当然，在您的源代码存储库之外）。
或者，您可以使用接收后挂钩在托管您的 Git 存储库的服务器上运行它。这将在您推送到服务器的存储库后运行。例如，您可以使用它自动将新文档上传到/docs/dev/项目的 Web 服务器上。
有关详细说明，请参阅Git 手册中有关钩子的章节。
于 2012-10-10T19:08:54.900 回答