git-cliff

公式Agent-ready

github.com開発ツール12.3kgit-cliff4 日前に更新

git-cliff について

git-cliff は Git コミットをパースして、Conventional Commits パターンに基づいて構造化された変更ログを生成します。カスタムテンプレートとフィルタリングルールに対応しており、開発者はプロジェクト慣例に合わせたリリースノートを自動生成できます。

OS またはパッケージマネージャーを選び、コマンドをターミナルで実行します。

brew install git-cliff

インストール後にgit-cliff --versionを実行して確認します。

よく使うコマンドを使う順に並べています。

git cliff --init

git cliff -o CHANGELOG.md

git-cliff は、conventional commits と正規表現を活用したカスタムパーサーを利用して、Git の履歴からchangelogファイルを生成できます。設定ファイルを使ってchangelog テンプレートをカスタマイズし、希望する形式に合わせられます。

アニメーション

公式ドキュメントでgit-cliffの使い方をご確認ください。

コミュニティが執筆したブログ記事もご覧いただけます。

git-journal - Git のコミットメッセージと変更履歴を生成するフレームワーク
clog-cli - Git のコミット履歴から見栄えのよい変更履歴を生成します
relnotes - プロジェクトのリリースノートを自動生成するツールです。
cocogitto - Conventional Commits と semver の仕様に対応する CLI ツール群です。
cliff-jumper - git-cliff と conventional-recommended-bump を組み合わせ、NodeJS パッケージのバージョンをセマンティックに更新し、git-cliff を活用した変更履歴を生成する NodeJS CLI ツールです。
release-plz - CI から Rust パッケージをリリースします。
git-changelog-command-line - Conventional Commits を使って変更履歴を生成し、次のバージョンを判定します。
git-changelog: Jinja2 テンプレートを使った変更履歴の自動生成ツールです。

素晴らしい皆さんに感謝します ✨

contrib.rocks で作成しました。

Apache License Version 2.0 または The MIT License のいずれかを選択してご利用いただけます。

Markdown 対応