ruby - コミット時にドキュメントを生成

Question

git commit ワークフローの一部として Ruby ドキュメントを自動生成するためのベスト プラクティスは何ですか? コミットがマスターにマージされるたびに、新しいドキュメントを自動的に生成したいと考えています。

Answer 1

Git フックを使用します。

クライアント側で実行する場合は、ポストコミット フックを使用します。基本的に、フックを登録すると ( に格納することで.git/hooks)、 Git は が成功するたびに指定した任意のスクリプトを呼び出しますgit commit。次に、スクリプトで RDoc または YARD を呼び出して、ドキュメントを出力ディレクトリ (もちろん、ソース コード リポジトリの外) に生成できます。

または、受信後フックを使用して、Git リポジトリをホストしているサーバーで実行することもできます。これは、サーバーのリポジトリにプッシュした後に実行されます。たとえば、これを使用して、新しいドキュメントを/docs/dev/プロジェクトの Web サーバーに自動的にアップロードできます。

詳細な手順については、Git マニュアルのフックに関する章を参照してください。