変更ログを実装する

  • 3 分

変更ログは単純です。プロジェクトに加えられた変更を一覧表示するファイルで、通常は日付別に整理されます。 一般的な形式にはバージョンが表示され、各バージョンの一覧が表示されます。

  • 追加された機能 - 実行できる新しい操作
  • 変更/改善された機能 - より適切に機能するもの
  • 削除された機能 - 削除された機能

一部のチームは、変更ログをブログ投稿として投稿します。 他のユーザーは、GitHub リポジトリに CHANGELOG.md ファイルを作成します。

自動変更ログ ツール

変更ログは手動で作成および管理できますが、自動ツールを使用して役立つ場合があります。 少なくとも開始点として。

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

git log コマンドは、コンテンツを自動的に作成するのに役立ちます。 たとえば、バージョンごとに新しいセクションを作成します。

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

Git変更ログ

一般的なツールの 1 つは gitchangelog です。 このツールは Python で記述されています。

GitHub changelog ジェネレーター

もう 1 つの一般的なツールは github-changelog-generator と呼ばれます。

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

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

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

通常は、ログ エントリを変更ログにコピーしないようにすることをお勧めします。 ログに含まれる技術的な詳細が多すぎるため、ユーザーが変更内容を理解するのに役立たない混乱を簡単に作成できます。