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