changelogツール比較

3つのカテゴリ

ホスト型ウィジェットとページ

エントリを彼らのエディタで書き、彼らがページをホストし、アプリ内ウィジェットを提供します。立ち上げが最も速く、エントリはあなたのではなく彼らのインフラ上に存在します。BeamerとAnnounceKitが最も明確な例です。

changelogが付属したフィードバックスイート

changelogは、機能投票、公開roadmap、フィードバック受信箱の隣にある1つのモジュールです。1社からループ全体が欲しい場合には価値がありますが、リリースノートを公開したいだけなら過剰です。Canny、Frill、Featurebaseがここに該当します。

あなたのリポジトリから生成

changelogは手動で入力するのではなく、コミット、プルリクエスト、issueから生成されます。CIで構築されるファイルから、作成・レビュー・公開されたエントリまで幅があります。git-cliffとgithub-changelog-generatorはファイル寄りの端にあり、LaunchNotes、Released、当社自身の製品は公開寄りの端にあります。

ひと目で

選び方

1. changelogがどこに表示される必要があるかから始めましょう。あなたの製品の一部のように見える必要がある場合、リンクを張るホスト型ページは、エディタがどれほど優れていてもがっかりさせるでしょう。あなたが必要なのは、再スタイリングできるウィジェットか、自分でレンダリングするフィードのどちらかです。リンクされたページで十分なら、ホスト型ツールははるかに少ない作業で済みます。
2. 次に、誰がエントリを書くかを尋ねてください。答えが「マージしたエンジニア」であれば、あなたのリポジトリを読むものを選んでください。それ以外は、全員が忙しいまさにその瞬間に手動のステップを追加するからです。答えがリリース計画に基づいて作業するプロダクトマーケターであれば、エディタの方が合っており、リポジトリの自動化はただ邪魔になるだけです。
3. 次に、ループの残りが必要かどうかを尋ねてください。機能投票と公開roadmapは本当に有用であり、本当に大きなコミットメントです。changelogモジュールのためにスイートを購入することは、チームが1つを使うために4つのものにお金を払う羽目になる方法です。
4. 最後に、離れる場合にあなたのエントリがどうなるかを確認してください。それらを構造化データとしてエクスポートするツールは、あなたがスクレイピングしなければならないホスト型ページにそれらが存在するツールとは大きく異なります。

当社自身のツールが合うところ、合わないところ

Changeloopは、マージされた各プルリクエストを読み取り、ユーザー向けのエントリを作成し、依存関係の更新とリファクタリングをフィルタリングし、レビューのために下書きを保持します。公開されたものは、隣にroadmapフィードを持つ公開JSONフィードに送られ、さらに2行のウィジェットとホスト型ページがフォールバックとして提供されます。フィードが要点です：意図された構成は、あなた自身の製品内で、あなた自身のコンポーネントでchangelogをレンダリングすることです。

次の場合は選ばないでください：

• あなたのリリースがリポジトリから生まれない場合。マージから、またはプッシュモードではプッシュから下書きを作成するため、Gitのワークフロー以外で配信するチームにはレビューするものが何もありません。
• 機能投票と、ユーザーが投票するroadmapが欲しい場合。roadmapフィードはありますが、それはユーザー投票ではなくラベル付きissueによって動きます。それにはフィードバックスイートが正しいカテゴリです。
• 洗練されたエディタと、メイン製品としてのホスト型ページが欲しい場合。ホスト型ページはフォールバックとして存在し、自社のものを中心に構築されたツールの方がそれをうまくやります。
• リポジトリに CHANGELOG.md だけが欲しい単独のオープンソースプロジェクトである場合。無料でまさにそのために作られたgit-cliffを使ってください。

よくある質問

そもそもツールは必要ですか？

しばらくは不要です。markdownファイル、または自社サイト上のページは、十分に良いchangelogであり、何もコストがかかりません。ツールが報われ始めるのは、エントリを書くことが省略されがちなステップになったとき、または3か所に同じエントリが欲しいが3つのコピーを維持したくないときです。

後でこれらの1つから移行できますか？

エントリが構造化データとして戻ってくるかどうかに完全に依存します。始める前に尋ねてください、後ではなく：これはリストの中で間違えると高くつく唯一の質問です。changelogは成長し続けるアーカイブであり、その2年分を打ち直すことは誰も承認するプロジェクトではないからです。

AIアシスタントで書くことについてはどうですか？

これらのほとんどは今、どこかでモデルを使って作成しています。それは、モデルに何が与えられるかよりもはるかに重要ではありません。コミットの件名しか見ないツールはその件名しか書き直せません。プルリクエストのタイトルと説明を見るツールは、ユーザーにとってそれが何をするかという観点で変更を説明するのに十分な情報を持っています。AIがあるかどうかではなく、入力が何かを尋ねてください。

参考記事：changelogの自動化とその限界、4つのステップのうちどれが自動化されるべきかについて。