変更ログを実装する

• 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 changelog ジェネレーター

もう 1 つの標準ツールは、github-changelog-generator 呼び出されます。

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

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

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

常に、ログ エントリを変更ログにダンプしないようにすることが優先されます。 ログは "ノイズ" であるため、役に立たない混乱を簡単に生成できます。