リリース プロセス
はじめに
コネクタの開発が完了したら、リリース プロセスを開始できます。リリース プロセスは初回リリース、後続リリースの両方で行いますが、一部の手順が若干異なる場合があります。リリース プロセスでは、コネクタが、コネクタとアプリのフレームワークに設定された基準を反映していることを確認します。このプロセスでは、次の手順を実行してリリースを作成する必要があります。
- 適切なバージョン管理を適用する
- コネクタのレビュー/検証を実行する
- リリース ノートを作成する
- リリースを作成する
バージョン管理
セマンティック バージョン管理を使用して、異なるバージョンのコネクタとアプリを追跡します。バージョン番号は 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
自動の初回の完全性チェック
コネクタの検証の準備が整ったら、プル要求 (PR) を使用してコンテンツを検証ブランチにマージする必要があります。この PR をマージできるのは、必要なコンテンツが存在するかどうかを確認する成果物チェックが成功した場合のみです。
技術的検証
コネクタの開発が完了し、コネクタのバージョン番号が適切である場合、コネクタはレビューのために UiPath に提出されます。すべての成果物が検証され、成果物が完成していて適切に機能することが確認されます。
コネクタ自体は、UiPath がユーザーに提供するリポジトリで提供されます。リポジトリの構造は、「成果物」に記載されている構造と同じです。すべての成果物が必要な仕様を満たしていることを確認してください。
リリース ノート
検証が正常に完了したら、リリース ノートを作成または確定できます。コネクタの初回リリースの場合は、コネクタの範囲に関する一般的な説明をリリース ノートに記載します。後続リリースのリリース ノートには、以前のバージョンに関して加えられた変更を記載する必要があります。
リリースを作成する
前の手順がすべて正常に完了したら、Git のコネクタからリリース タグを作成できます。リリース タグの作成方法については、GitHub Docs の「リポジトリのリリースを管理する」をご覧ください。