コンテンツへスキップ

Conventional Commit と semver バンプのヘルパー

前回のリリース以降のコミットサブジェクトを貼り付け、現在のバージョンを入力すると、次のセマンティックバージョン、各コミットの妥当性チェック、そしてそのまま貼り付けられる変更履歴が得られます。

Bump
major
Next version
2.0.0
Commits
6 valid
1 not conventional
CommitTypeScopeBreakingValid
feat(api): add cursor pagination to /ordersfeatapiyes
fix(auth): refresh expired session tokensfixauthyes
perf(search): cache query plansperfsearchyes
docs: explain webhook retriesdocs-yes
refactor(db)!: drop legacy orders tablerefactordbyesyes
chore: bump dev dependencieschore-yes
update stuff--no

Changelog

## 2.0.0

### Breaking changes
- **db:** drop legacy orders table

### Features
- **api:** add cursor pagination to /orders

### Bug fixes
- **auth:** refresh expired session tokens

### Performance
- **search:** cache query plans

すべての処理はお使いのブラウザー内で行われます。入力した内容が外部に送信されることはありません。

使い方

  1. コミットサブジェクトを1行に1つずつ貼り付けてください。例えば git log --format=%s の出力を使用できます。
  2. 現在のバージョンを入力してください。プロジェクトが1.0未満の場合は 0.x のオプションにチェックを入れてください。
  3. バンプ、次のバージョン、変更履歴を確認してください。無効とマークされたコミットは、ツールが読み取れるように修正してください。

よくある質問

コミットはどのようにセマンティックバージョンのバンプに対応しますか?

破壊的変更(タイプの後の ! または BREAKING CHANGE フッター)は major をバンプし、feat は minor を、fix や perf は patch をバンプします。その他のタイプ単独ではリリースされません。

有効なコミットはどのような形式ですか?

type(scope)!: description の形式です。scope と ! は省略可能です。例として feat(api): add pagination や fix!: change the default timeout などがあります。

1.0未満ではセマンティックバージョニングはどのように機能しますか?

1.0より前は何でも変更される可能性があります。多くのツールでは1段階下げて扱い、破壊的変更は minor を、機能追加は patch をバンプします。それに合わせるにはオプションにチェックを入れてください。

どのツールがこれを自動化しますか?

semantic-release、release-please、commitlint はいずれも Conventional Commits を読み取ります。このツールは、何もインストールせずにそれらが何を行うかを示します。

compiler.dev が提供する、より高速な GitHub Actions ランナーで作成されました。その他の無料ツールもご利用いただけます。

このツールをご自身のサイトに埋め込む

ブログやドキュメントへの埋め込みは無料です。表示させたい場所に次の HTML を貼り付けてください:

<iframe src="https://compiler.dev/embed/conventional-commit-semver-helper" title="Conventional commit and semver bump helper" width="100%" height="560" style="border:1px solid #e5e7eb;border-radius:12px" loading="lazy"></iframe>
<p style="font-size:12px">Calculator by <a href="https://compiler.dev/tools/conventional-commit-semver-helper">compiler.dev</a></p>