正確なリリース変更ログを生成する最良の方法は何ですか?


8

リリースごとに正確な変更ログを提供したいプロジェクトに取り組んでいますが、手間をかけずに機能する変更ログを収集する方法が見つかりませんでした。問題は主に、バージョン間の時間が長く、各バージョンに多くの機能とバグ修正が同梱されている場合、およびソフトウェアに複数のブランチが同時に開発されている場合です。

私が検討したいくつかのオプション:

  1. コミットメッセージから変更ログを作成し、開発者が変更ログの行を作成する場合と同じようにメッセージを書き込むように要求します(実際には変更ログを作成します)。
    • 複数のブランチがあり、ブランチ間でマージする場合は機能しない可能性があります(どのコミットが最終的にリリースで終わったかを知るのは難しいかもしれません)。
  2. コードの変更ごとに、バグ追跡システムに対応するチケットが必要であることを要求します。変更ログは、チケットに基づいて書き込むことができます。
    • 開発者は、特にバグの修正よりもチケットの作成に時間がかかる場合は、マイナーな変更のチケットを作成するだけでもイライラするかもしれません。
  3. 開発者がコードに変更を加えると同時に、常に変更ログを(プロジェクトルートのテキストファイルとして)更新する必要があります。
    • 自動化できる手作業のように感じます。
  4. プロジェクトマネージャーに、現在のバージョンと以前のバージョンの差分を取り、変更されたことがわかったものに基づいて、その時点で変更ログを書き込むよう依頼します。
    • リリースの責任者のための余分な作業。コードを見ただけでは、変更の実際的な効果が何であるかは明らかではない場合があります。
  5. リリース予定の機能のみを出荷してください。コーディングを始める前でも、変更ログを書き込むことができます。
    • ウォーターフォールモデルを使用していない限り、実際のオプションではありません。

私はこれらのそれぞれまたはそれらのバリエーションを過去に使用したことがありますが、それらはあまりにも信頼性が低く、面倒で、堅固でした。問題を解決する方法について魔法の弾丸または良いアイデアを持っている人はいますか?


QAはその目的のために作成されたものです。
mouviciel

@mouviciel:QAで働くほとんどの人はあなたの発言に同意しないと思います;-)
Treb

1
@Treb:QAなので、あなたはまあまあです。Docはリリース変更ログを書き込みます。すでに存在するものが正確であることを確認するだけです。
Steven Evers、2011年

回答:


6

変更ごとにチケットの要件がまだない場合、変更ログに記録されるのに十分重要な変更ごとにチケットを開発者に作成させることは合理的であると思われます。

変更がユーザーに知らせるのに十分なほど重要である場合は、とにかくチケットの下でその変更を行いたいと思われるので、説明的なチケットを書くことは良い方法です。さらに、バグトラッカーが持っているリリースのバージョン管理とロードマップのサポートとこれを結び付けることができます。


+1これは質問の#2と一致し、私が最も効果的に機能するものです。質問自体のサブテキストに関して、チケットなしでバグ修正をコミットしてほしいですか?
sdg

0

自動化できる手作業のように感じます。

どのように自動化できますか?コミットごとに変更ログを編集する必要はありませんが、言及する価値のある機能が追加された場合のみです。これはソフトウェアで頻繁に発生するので、変更ログに毎回1行を追加するのは面倒です。


0

これは、変更ログを更新し続けるQAの義務であると言えるかもしれませんが、一部のソフトウェア構成管理システムまたは問題トラッカーは、変更ログを自動的に生成できるため、複数の開発者環境で役立ちます。これは、意図したとおりに機能/問題追跡を使用していることを前提としています。

たとえば、オープンソースの課題追跡であるTracにはChangeLogMacroがあります。

他の課題追跡には、変更ログを生成できるマクロまたはプラグインがある場合があります。これは通常、前回のリリースから現在のリリースまでにクローズされたすべてのチケット/問題を選択する単純なクエリです。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.