Process Mining

リリースプロセス

はじめに

コネクタの開発が完了したら、リリースプロセスを開始できます。リリースプロセスは初回リリース、後続リリースの両方で行いますが、一部の手順が若干異なる場合があります。リリースプロセスでは、コネクタが、コネクタとアプリのフレームワークに設定された基準を反映していることを確認します。このプロセスでは、次の手順を実行してリリースを作成する必要があります。

適切なバージョン管理を適用する
コネクタのレビュー/検証を実行する
リリースノートを作成する
リリースを作成する

バージョン管理

セマンティックバージョン管理を使用して、異なるバージョンのコネクタとアプリを追跡します。バージョン番号は X.Y.Z で示され、以下のガイドラインに従って更新されます。

Z は、データモデルに影響しないバグ修正の場合に更新されます。
Y は、データモデルに対応した新機能の場合に更新されます。
X は、データモデルとの相互運用性が失われる変更の場合に更新されます。

アプリとコネクタの重要なマイルストーンとなる場合は、新しいリリースになります。

コネクタは、アプリのデータモデルに対応するデータを出力します。コネクタのメジャーバージョン番号は、アプリのどのメジャーバージョンに対応するかを示すために使用されます。たとえば、sample-connector 1.2.3 は sample-app 1.x.x に対応します。x は任意の数です。

Apps (アプリ)

アプリは、データモデルを考慮してバージョン管理されます。次の例で、バージョン番号の更新方法を説明します。

メトリック total_ordered_value が、フィールド requested_value ではなく ordered_value を使用するように変更された。
- Z を更新: アプリ 1.0.0 → アプリ 1.0.1
ユーザーエンティティがアプリに追加される。アプリには、新しく追加されたユーザーエンティティに基づいて新しいコンテンツが設定されます。アプリを使用するためにユーザーエンティティのデータを含める必要はありません。
- Y を更新: アプリ 1.0.1 → アプリ 1.1.0
データモデルが更新され、requisitions テーブルが requisition_headers と requisition_items に分割される。つまり、現在の 1.x.x のすべてのコネクタは新しいアプリに非対応になります。
- X を更新: アプリ 1.1.0→ アプリ 2.0.0

コネクタ

コネクタ 1.x.x はアプリ 1.x.x にのみ対応します。これは、メジャーバージョン 1 のすべてのアプリです。アプリに破壊的変更が導入されたため、コネクタ 1.x.x は App 2.x.x には対応しません。コネクタのメジャー番号が、対応するアプリより大きくなることはあり得ません。

次の例で、バージョン番号の更新方法を説明します。

ordered_value フィールドは、requested_value のデータソースフィールドに基づいていたが、修正が行われ、正しいデータソースフィールドがコネクタ内で使用されるようになった。
- Z を更新: コネクタ 1.0.0 → コネクタ 1.0.1
また、コネクタがユーザーエンティティデータを出力するようになり、アプリで新しく利用可能になるダッシュボードを使用できるようになった。これは必須のエンティティではありません。
- Y を更新: コネクタ 1.0.1 → コネクタ 1.1.0
アプリ 2.0.0 の新しいデータモデルに一致するように、requisitions テーブルが requisition_headers と requisition_items に分割される。
- X を更新: コネクタ 1.1.0→ コネクタ 2.0.0