注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。
アクションタイプをブランチ化する
オントロジーアクションは Global Branching と統合されており、本番環境に影響を与えずにブランチ上でアクションタイプをテストできます。変更を main にマージする前に、分離されたブランチのコンテキストでアクションを実行し、設定を検証し、編集結果を確認できます。ブランチ上の編集はマージされません。
Global Branching の概念やワークフローに関する一般的な情報については、Global Branching のドキュメントを参照してください。
ブランチ上でアクションを実行する
ブランチ上の Workshop モジュールでアクションをテストし、正しく設定されていることを検証できます。関連するすべてのオブジェクトタイプがブランチ上でインデックス化されていれば、アクションタイプを実行し、そのブランチ上で編集結果を確認できます。
前提条件
ブランチ上でアクションを実行するには、そのアクションタイプによって編集されるすべてのオブジェクトタイプが、そのブランチ上でインデックス化されている必要があります。Ontology Manager の個々のオブジェクトタイプのページ、またはアクションタイプのページから、オブジェクトタイプをインデックス化できます。
Ontology Manager でアクションタイプを編集するとき、そのアクションタイプがブランチ上でインデックス化されていないオブジェクトタイプを変更する場合は、警告が表示されます。
これらのオブジェクトタイプがインデックス化される前にアクションを実行すると、アクションによる編集は適用されません。トースト通知には、アクションは有効であるものの、編集対象のオブジェクトタイプのうち1個以上がブランチ上で読み取り専用であることが表示されます。この通知には Ontology Manager へのリンクがあり、アクションを再実行する前に、残りのオブジェクトタイプをインデックス化できます。
ブランチ上でのアクションの実行は、テストのための仕組みです。ブランチ上のアクションによる編集が main にマージされることはありません。
ブランチ上で関数ベースのアクションを使用する
ブランチ上の関数ベースのアクションは、ブランチに対応しているかどうかによって動作が異なります。ブランチ対応の関数は、ブランチ上で変更でき、そのブランチからスキーマを読み取ります。一方、ブランチ非対応の関数は main からのみスキーマを読み取ります。ブランチへの対応状況にかかわらず、すべての関数ベースのアクションはブランチ上でのみ実行され、変更を main に書き込むことはありません。サポートされている関数の種類については、Global Branching のドキュメントを参照してください。
ブランチ上の副次的効果を管理する
以下の情報は、ブランチ上でアクションを通じて適用される Webhook、外部呼び出しを行う関数、および通知にのみ適用されます。ほかの方法で適用される副次的効果は、それらを利用する側で定義されたとおりに動作します。
Webhook
デフォルトでは、ブランチ上でアクションが適用されても Webhook は実行されません。これは、テスト環境で誤って外部システムに書き込むことを防ぐための動作です。
この場合、この動作を示すトースト通知が表示されます。
ただし、READ エンドポイントへのアクセスなど、ブランチ上で Webhook をテストすることが望ましい場合もあります。
デフォルトの動作をオーバーライドするには、Ontology Manager でアクションタイプのセキュリティと実行条件タブを設定し、ブランチ上での Webhook の実行を有効にします。
ブランチ上での Webhook を有効にすると、Webhook は main 上とまったく同じように実行されます。そのため、Webhook が外部の本番環境にアクセスするように設定されている場合、アクションをブランチ上で実行しても、引き続きその本番環境にアクセスします。
外部呼び出しを行う関数
デフォルトでは、ブランチ上でアクションが適用されると、外部呼び出しを行う関数ベースのアクションロジックは実行されず、アクション全体が失敗します。これは、テスト環境で誤って外部システムに書き込むことを防ぐための動作です。
この場合、失敗を示すトースト通知が表示され、この動作の説明が示されます。
ただし、READ エンドポイントの呼び出しなど、ブランチ上でのテストが必要な場合もあります。Ontology Manager のアクションタイプのセキュリティと実行条件タブで、ブランチ上での外部呼び出しを行う関数を有効にすると、この制限をオーバーライドできます。
ブランチ上での外部呼び出しを行う関数を有効にすると、関数は main 上と同じ外部呼び出しを行います。そのため、関数が外部の本番環境にアクセスするように設定されている場合、アクションをブランチ上で実行しても、引き続きその本番環境にアクセスします。
通知
デフォルトでは、ブランチ上でアクションが適用されても通知は実行されません。これは、テスト環境で誤って受信者に通知することを防ぐための動作です。
この場合、この動作を示すトースト通知が表示されます。
ただし、ブランチ上で通知をテストすることが望ましい場合もあります。
デフォルトの動作をオーバーライドするには、Ontology Manager のアクションタイプのセキュリティと実行条件タブで、ブランチ上での通知を有効にできます。
また、アクションがブランチ上で実行されるときの通知の受信者を指定できます。
- ブランチ所有者： すべての通知をブランチ所有者に送信します。
- デフォルトの受信者： 元の通知に設定されている受信者に通知します。
既知の制限事項
- ブランチ上のアクションによる編集はテスト専用であり、
mainにマージされることはありません。 - デフォルトでは、ブランチ上でアクションを実行しても Webhook とメール通知は実行されません。
- デフォルトでは、ブランチ上でアクションを実行すると、外部システムを呼び出す関数は失敗します。