conventional-changelogでGitのログを出力し、リリース時の変更点を確認しよう

いなば

2015.06.12

フロントエンドエンジニアの稲葉です。

今回はGitのコミット内容から変更点のログを生成するツール「conventional-changelog」をご紹介したいと思います。
Gitで管理しているプロジェクトのリリース時などにご活用ください。

conventional-changelogとは

conventional-changelog
https://github.com/ajoslin/conventional-changelog

決まったフォーマットでコミットログを書くことにより、Gitのコミットメッセージからログを出力することができるツールです。
直前のgitタグから現在のHEADまでの間のログを生成することができます。

出力された結果はこちらのようになります。

※現在このページは表示できません。

リリース時の変更点が、バグ修正や新規実装などの種類ごとに箇条書きで整理されて、とても見やすいですね。
Githubリポジトリと紐付けることでコミットへのリンクも自動で貼られるので、リリース内容の確認がとても楽になります。

conventional-changelogのインストール

まずはconventional-changelogをインストールします。

$ npm install conventional-changelog
※Macユーザの場合はroot権限での実行を求められるのでsudo npm〜としてください。
※ログファイルを出力するためにNode.jsも使います。もしインストールしていなければインストールしてください。
conventional-changelogを実行する準備
次にchangelog.jsをnode_modulesと同じ階層に作成します。
changelog.js
var changelog = require(“conventional-changelog“);
var fs = require(“fs“);

changelog({
    repository: 'https://github.com/i78s/ligblog-sample',    // 紐付けたいリポジトリを指定します。
    version: require('./package.json').version    // バージョンを表す文字列を指定します。
}, function(err, log) {
    fs.writeFileSync(“./CHANGELOG.md“, log);
});
これでログをマークダウンに出力できる準備ができました。
changelogの1つ目の引数はオプション、2つ目はコールバック関数になります。

今回はコールバックで「CHANGELOG.md」という名称のマークダウンファイルを出力します。
次のページ
コミットメッセージのフォーマット。
         
                         LIGはWebサイト制作を支援しています。ご興味のある方は事業ぺージをぜひご覧ください。
              Webサイト制作の実績・料金を見る