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