変更ログを実装する

  • 3 分

変更ログの概念は十分にシンプルです。それは、プロジェクトに加えた変更の一覧が、通常は日付順に含まれているファイルです。 一般的な内訳は、バージョンのリストを区切り、各バージョン内で次を示します。

  • 追加された機能
  • 変更または改善された機能
  • 削除された機能

変更ログをブログ記事として投稿するチームもあれば、GitHub リポジトリに CHANGELOG.md ファイルを作成するチームもあります。

自動変更ログ ツール

変更ログを作成して手動で管理することもできますが、自動化された変更ログ作成ツールの使用を検討することをお勧めします。 少なくとも開始点として。

ネイティブ GitHub コマンドの使用

git log コマンドは、コンテンツを自動的に作成する場合に便利です。 バージョンごとに新しいセクションを作成する例は次のとおりです。

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Git の変更ログ

標準ツールの 1 つとして gitchangelog があります。 このツールは Python に基づいています。

GitHub 変更ログ ジェネレーター

もう 1 つの標準ツールは github-changelog-generator と呼ばれるツールです。

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

このツールは Gem に基づいています。

自動生成されたログベースのデータを使用する必要がある場合

優先される設定は常に、ログ エントリを変更ログにダンプしないようにすることです。 ログは "ノイズが多い" ので、無用な混乱が簡単に生じます。