@ledsun blog

無味の味は佳境に入らざればすなわち知れず

Conventional CommitsのBREAKING CHANGEは二行目に書く

Standard Version を使ってコミットログから自動的にバージョン番号を生成しています。 バージョン番号にマーケティング的な意味がない場合は、自動的に決定されるのがとても便利です。

今回BREAKING CHANGEに当たる変更だと思い、次のように書きました。

BREAKING CHANGE: Change the keystrokes for copy and paste to match the standard OS operation

We will use the system clipboard to realize copy and paste between multiple editors. In order to access the system clipboard while keeping browser security in mind, we will handle copy and paste events for standard OS operations. In Chrome and Safafi, copy and paste events for elements other than EditableContent are fired for the Body element, so we use EditorContainer to handle events instead of individual editors.

メジャーバージョンアップするどころか、コミットログがchangelogに載りません。

Conventional Commits をよく読んだら

BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning).

フッターに書けって書いてありました。 というわけで、次のように書いたら上手く行きました。

feature: Change the keystrokes for copy and paste to match the standard OS operation

BREAKING CHANGE:
We will use the system clipboard to realize copy and paste between multiple editors. In order to access the system clipboard while keeping browser security in mind, we will handle copy and paste events for standard OS operations. In Chrome and Safafi, copy and paste events for elements other than EditableContent are fired for the Body element, so we use EditorContainer to handle events instead of individual editors.