更新履歴を自動生成するには
このページでは、annai（ソースコードからユーザー向けマニュアルを自動生成するツール）が Git（ソースコードの変更履歴を管理するツール）のコミット履歴から更新履歴ページを自動で生成する仕組みを説明します。
対象となるコミットメッセージの形式
更新履歴に掲載されるのは、以下の3種類のコミットメッセージのみです。
feat:（新機能の追加を示す接頭辞） — 例: 「CSVエクスポート機能を追加」→ 更新履歴では「CSVエクスポート機能が使えるようになりました」と表示されますfix:（不具合の修正を示す接頭辞） — 例: 「ログイン時にエラーが発生する問題を修正」→ 更新履歴では「ログイン時の問題が修正されました」と表示されますperf:（動作速度の改善を示す接頭辞） — 例: 「データ読み込み速度を改善」→ 更新履歴では「データの読み込みが速くなりました」と表示されます
手順
-
ソースコードの変更をコミット（変更の記録）する際に、コミットメッセージの先頭に
feat:、fix:、perf:のいずれかを付けます。 -
マニュアルを生成します。更新履歴ページは生成時に自動で作成されます。
annai gen -
生成が完了したら、出力先フォルダ内の
changelog.mdxを開き、更新履歴の内容を確認します。
ここまでの手順が完了すると、コミット履歴にもとづいた更新履歴ページがマニュアルに追加された状態になります。
警告
「更新履歴はまだありません」と表示される場合は、feat:、fix:、perf: で始まるコミットが存在するか確認します。refactor: や chore: で始まるコミットは更新履歴の対象外です。
プロジェクトが Git で管理されていない場合も、更新履歴は空になります。