統合の概要
統合は、Git ホスティングやSlackボットなどの外部サービスを使用したり、GitHub のコードリビュープルリクエスト機能の使用など、現在の開発プロセスを維持管理したりするのに役立ちます。 クラウドインフラストラクチャー上のAdobe Commerce プロジェクトに次の統合を追加できます。
Cloud CLI を使用して統合を追加するには:
次のコマンドを実行すると、新しい統合のタイプとオプションを選択するための対話型プロンプトが表示されます。
code language-bash |
---|
|
プロジェクトに設定されている統合を一覧表示するには、次の手順に従います:
code language-bash |
---|
|
応答の例:
code language-terminal |
---|
|
を使用して統合を追加するにはCloud Console:
-
対象: プロジェクト設定 を選択し、 Integrations.
-
統合タイプをクリックするか、 Add integration.
-
統合タイプの選択と設定の手順について説明します。
-
統合を追加すると、統合ビューのリストに表示されます。
Commerce Webhook
を使用して、クラウドプロジェクトにCommerce Webhook を設定できます ENABLE_WEBHOOK グローバル変数. Commerce Webhook は、Commerceが生成したイベントに応答して、外部サーバーにリクエストを送信します。 この Webhook ガイド では、この機能について詳しく説明します。
汎用 Webhook
へのカスタム Webhook 統合を使用すると、クラウドインフラストラクチャーとリポジトリのイベントを取得してレポートできます POST
に対する JSON メッセージ webhook URL。
Webhook URL を追加するには、次の構文を使用します:
magento-cloud integration:add --type=webhook --url=https://hook-url.example.com
type
– を指定するwebhook
統合タイプ。url
- JSON メッセージを受信できる Webhook URL を指定します。
応答のサンプルでは、統合をカスタマイズする機会を提供する一連のプロンプトを示しています。 デフォルト(空白)の応答を使用すると、プロジェクト内のすべての環境のすべてのイベントに関するメッセージが送信されます。
レポート固有になるように統合をカスタマイズできます イベントブランチにコードをプッシュするなど。 例えば、 environment.push
ユーザーがブランチにコードをプッシュする際にメッセージを送信するイベントです。
Events to report (--events)
A list of events to report, e.g. environment.push
Default: *
Enter comma-separated values (or leave this blank)
>
でイベントの報告を選択できます。 pending
, in_progress
、または complete
都道府県:
States to report (--states)
A list of states to report, e.g. pending, in_progress, complete
Default: complete
Enter comma-separated values (or leave this blank)
>
また、次のことができます 次を含める または 除外 特定の環境向けのメッセージ:
Included environments (--environments)
The environment IDs to include
Default: *
Enter comma-separated values (or leave this blank)
>
Excluded environments (--excluded-environments)
The environment IDs to exclude
Enter comma-separated values (or leave this blank)
>
統合が完了すると、値の概要が表示されます。
Created integration integration-ID (type: webhook)
+-----------------------+------------------------------+
| Property | Value |
+-----------------------+------------------------------+
| id | integration-ID |
| type | webhook |
| events | - '*' |
| environments | - '*' |
| excluded_environments | { } |
| states | - complete |
| url | https://hook-url.example.com |
+-----------------------+------------------------------+
既存の統合を更新
既存の統合は更新できます。 例えば、の状態を次のように変更します。 complete
対象: pending
次を使用します。
magento-cloud integration:update --states=pending <int-id>
応答の例:
Integration integration-ID (webhook) updated
+-----------------------+------------------------------+
| Property | Value |
+-----------------------+------------------------------+
| id | integration-ID |
| type | webhook |
| events | - '*' |
| environments | - '*' |
| excluded_environments | { } |
| states | - pending |
| url | https://hook-url.example.com |
+-----------------------+------------------------------+
報告するイベント
environment.access.add
environment.access.remove
environment.activate
environment.backup
environment.branch
environment.deactivate
environment.delete
environment.initialize
master
最初のコミットで初期化されたプロジェクトのブランチenvironment.merge
environment.push
environment.restore
environment.route.create
environment.route.delete
environment.route.update
environment.subscription.update
master
サブスクリプションが変更されたので環境のサイズが変更されましたが、コンテンツの変更はありませんenvironment.synchronize
environment.update.http_access
environment.update.restrict_robots
environment.update.smtp
environment.variable.create
environment.variable.delete
environment.variable.update
project.domain.create
project.domain.delete
project.domain.update