注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

オントロジーの提案 [レガシー]

オントロジーブランチ(旧称:オントロジーの提案)はサンセットの段階にあります。Global Branching が有効なエンロールメントでは、オントロジーブランチを作成できなくなりました。代わりに、グローバルブランチを使用してオントロジーを変更し、データソースのブランチ作成、対応アプリケーションでの下流の変更テスト、統一されたワークフロー内でのデータとオントロジーの変更管理など、拡張された機能を利用してください。

オントロジーブランチを使用すると、オントロジーのメインバージョンに基づくブランチで、そのオントロジーを変更できます。このプロセスにより、すべての変更がメインのオントロジーに組み込まれる前にレビューされ、承認されることが保証されます。

ブランチを作成するには、リソースを含むプロジェクトに対する編集者権限が必要です。

定義

  • ブランチ: オントロジーのブランチは、メインバージョンから派生した、そのオントロジーの別のバージョンです。メインブランチに影響を与えることなく、試行や変更ができるように設計されています。これにより、ユーザーは分離された環境でオントロジーの調整をテストして改善してから、メインブランチにマージできます。

  • 提案: 提案は、バージョン管理システムのプルリクエストに相当するもので、オントロジーブランチ向けに特化しています。提案はブランチと同時に自動的に作成され、レビュー、名前、メインブランチにマージする変更の説明などのメタデータを含みます。提案は、別のブランチで行われた変更をメインのオントロジーに統合する前に、レビューして承認するための仕組みとして機能します。

オントロジーのブランチ作成ワークフロー

オントロジーの一般的なブランチ作成ワークフローには、5つのステップがあります。

  1. ブランチを作成する
  2. 提案をレビューに向けて準備する
  3. レビューを依頼する
  4. 提案をレビューする
  5. 提案をリリースする

以下のセクションで各ステップを説明します。

1. ブランチを作成する

ブランチの作成を選択すると、提案のタイトルと説明を指定するダイアログが開き、ブランチを作成できます。

また、提案に含めたいオントロジーの変更がすでにある場合は、保存を選択し、保存ダイアログで変更を提案するを切り替えることもできます。

変更を提案する。

オントロジーのメインブランチにいて、変更がない場合は、ブランチ選択コンポーネントを選択し、新しいブランチの名前を入力してブランチを作成することもできます。

提案のブランチは、メインのオントロジー設定でのみ作成できます。別の提案に基づいて新しいブランチを作成することはできません。

ブランチで作業している間は、ワークスペースのインターフェースの上にあるブランチナビゲーションのトップバーに、現在のブランチが表示されます。

ブランチナビゲーションのトップバー。

2. 提案をレビューに向けて準備する

この時点で、提案の作成方法によっては、このブランチにすでに変更が含まれている場合があります。このブランチで作業している間は、作成や削除を含め、オントロジーリソースの変更を引き続き行えます。

変更されたオントロジーのエンティティはそれぞれ、提案内の個別のタスクとなり、レビューできるようになります。

オントロジーロールを使用するように移行したリソースでは、閲覧者も提案内でリソースを変更できます。リソースがデータソースから派生した権限を使用している場合は、編集者または所有者のみが提案内でそのリソースを変更できます。

3. レビューを依頼する

ブランチに変更を加えた後、提案にレビュー担当者を追加できます。追加するには、トップバーにある提案の詳細を開くを選択して、提案の表示画面に移動します。

ブランチを離れた場合は、提案タブに移動して提案を選択するか、ブランチ選択コンポーネントを使用して、提案の概要に移動できます。

そこで、レビュー担当者セクションからレビュー担当者を割り当てます。

提案がレビュー中の段階になるまで、レビュー担当者には通知されません。

提案内のタスクにコメントを残して、提案した変更の背景を説明することもできます。タスクのコメントセクションにアクセスするには、レビュータブを選択し、次に右端のコメントサイドバーを選択します。

4. 提案をレビューする

レビュー担当者は、レビュータブで個々のタスクを承認または拒否し、レビューを補足するコメントを追加できます。

変更を承認するには、レビュー担当者に所有者権限または編集権限が必要です。

権限のないユーザーも、たとえば変更についての意見を伝えるためにタスクをレビューできますが、タスクの承認ステータスには影響しません。

提案の作成者が、編集されたすべてのリソースに対して所有者権限または編集者権限を持っている場合は、自身の変更を承認できます。

ベストプラクティス

編集者または所有者は、レビュー担当者として明示的に追加されていなくても、提案を承認できます。レビュー担当者リストは、誰が変更をレビューすべきかを把握するために使用することを推奨しますが、オントロジーを保護する手段としては使用しないでください。代わりに、ロールと権限を慎重に割り当ててオントロジーを保護してください。

5. 提案をリリースする

変更がレビューされ、承認されると、提案をオントロジーにマージできます。マージに特別な権限は必要ありません。ブランチを編集できる人であれば、誰でも承認済みの提案をマージできます。

提案がマージされると、サイドバーのレビュー中セクションからマージ済みセクションに移動します。

提案をマージする前であれば、いつでもサイドバーから削除を選択して提案を閉じることができます。

提案は、メインのオントロジー設定にのみマージできます。

提案を自動的に元に戻すことはできません。提案を元に戻すには、提案内の個々の変更を元に戻す必要があります。

提案を一度閉じると、再度開くことはできません。