出力する項目がない(壊れた設定)
docs だけの一覧でその他を含めない設定にした例です。出力する項目が 0 件になるため、警告で知らせます。
入力
git log --oneline の出力
abc1234 docs: x
その他のコミット
下書きに含めない(新機能・修正・破壊的変更だけ)
結果
エラー 0 件・警告 1 件・情報 0 件
指摘(エラー・警告・情報)
- 警告 全体 出力する項目がありません。「その他を含めない」を選んでいて、feat・fix・破壊的変更のコミットがなかった可能性があります。
リリースノートの下書き(Markdown)
検算(この結果になる理由)
docs は feat・fix 以外で、含めない設定のため、出力できる項目が 1 つもありません。空のテキストと、設定を確認する警告が返ります。
判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。
このツールの制約
- 読めるのはコミットの 1 行目だけです。本文のフッターにある BREAKING CHANGE は、--oneline の出力に含まれないため検出できず、type の後ろの ! がある場合だけ破壊的変更になります。
- マージコミットや、チーム独自の書き方のコミットは「その他」に入ります。内容の要約や言い換えはせず、1 行目をそのまま使います。
- 下書きは参考です。読み手に伝わる文面にするには、人が表現を整える必要があります。
ご利用にあたって
- 生成された下書きをそのまま公開せず、内容を読んで確認してください。
- コミットメッセージに含まれる機密情報や個人名を、公開前に確認してください。