ドキュメントCommerceクラウドインフラストラクチャー上の Commerce に関するガイド

GitHub 統合

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 管理者
  • 開発者

GitHub 統合を使用すると、クラウドインフラストラクチャ環境でAdobe Commerceを GitHub リポジトリから直接管理できます。 この統合では、既に GitHub に存在するコンテンツを管理し、クラウドインフラストラクチャコードリポジトリ上のAdobe Commerceと同期します。 基本的に、コードリポジトリは GitHub リポジトリのミラーになります。

NOTE
Adobeでは、クラウドインフラストラクチャプロジェクト上のAdobe Commerceにプライベートリポジトリを使用して、拡張機能や機密設定などの専有情報または開発作業をすべて保護することを強くお勧めします。

この統合により、次のことが可能になります。

  • ブランチの作成時に環境を作成します
  • プルリクエストを結合する際に環境を再デプロイ
  • ブランチを削除したら、環境を削除します

プロセスを続行するには、GitHub トークンと Webhook を取得する必要があります。

前提条件

  • Adobe Commerce on cloud infrastructure プロジェクトへの管理者アクセス
  • GitHub リポジトリ
  • GitHub 個人用アクセストークン

GitHub トークンの生成

GitHub 開発者設定で、従来の個人用アクセストークンを作成します。 リポジトリに プッシュ できるように、GitHub リポジトリへの書き込みアクセス権を持つグループのメンバーである必要があります。 トークンを作成する際には、次の範囲を含めます。

  • admin:repo_hook - Web フックの作成
  • repo - リポジトリとの統合
  • read:org – 組織リポジトリとの統合

詳しくは、「GitHub：作成」を参照してください。

リポジトリを準備

既存の環境からクラウドインフラストラクチャー上のAdobe Commerce プロジェクトのクローンを作成し、同じブランチ名を保持したまま、プロジェクトのブランチを新しい空の GitHub リポジトリに移行します。 Adobe Commerce on cloud infrastructure プロジェクトで既存の環境やブランチが失われないように、同一の Git ツリーを保持することが 重要 です。

  1. ターミナルから、クラウドインフラストラクチャプロジェクトのAdobe Commerceにログインします。

    code language-bash 
    magento-cloud login

  2. プロジェクトをリストして、プロジェクト ID をコピーします。

    code language-bash 
    magento-cloud project:list

  3. プロジェクトのクローンをローカル環境に作成します。

    code language-bash 
    magento-cloud project:get <project-ID>

  4. GitHub リポジトリをリモートとして追加します。

    code language-bash 
    git remote add origin git@github.com:<user-name>/<repo-name>.git

    リモート接続の既定の名前は origin または magento です。 origin が存在する場合は、別の名前を選択するか、既存の参照の名前を変更または削除できます。 git-remote ドキュメントを参照してください。

  5. GitHub リモートが正しく追加されていることを確認します。

    code language-bash 
    git remote -v

    期待される応答：

    code language-none 
    origin git@github.com:<user-name>/<repo-name>.git (fetch)
origin git@github.com:<user-name>/<repo-name>.git (push)

  6. プロジェクトファイルを新しい GitHub リポジトリにプッシュします。 すべてのブランチ名は同じにしておくことを忘れないでください。

    code language-bash 
    git push -u origin master

    新しい GitHub リポジトリで開始する場合は、リモートリポジトリがローカルコピーと一致しないので、-f オプションを使用する必要がある場合があります。

  7. GitHub リポジトリにすべてのプロジェクトファイルが含まれていることを確認します。

GitHub 統合の有効化

開始する前に、プロジェクトコードと環境を GitHub リポジトリに配置する必要があります。 統合を有効にすると、GitHub リポジトリがコードソースになります。 コードの変更を元の magento リポジトリにプッシュした場合、コードの変更を GitHub リポジトリにプッシュすると、統合によって上書きされます。

以下は GitHub 統合を有効にし、Webhook の作成時に使用するペイロード URL を指定します。

WARNING
次のコマンドは、production ブランチを含むすべてのブランチを含む GitHub リポジトリのコードで、クラウドインフラストラクチャプロジェクトのAdobe Commerceの すべて コードを上書きします。 このアクションは即座に実行され、元に戻すことはできません。 ベストプラクティスとして、クラウドインフラストラクチャプロジェクト上のAdobe Commerceからすべてのブランチをクローンし、GitHub リポジトリにプッシュすることが重要です 事前に。

magento-cloud integration:add を使用して CLI プロンプトをステップ実行するか、次のオプションを使用して統合コマンドを構築するかを選択できます。

オプション
必須？
説明
--base-url
はい
サーバーインストールのベース URL （https://github.com/ またはカスタム）。 リポジトリが公開 Github でホストされている場合は、このオプションを省略します。
--token
はい
GitHub 用に生成した個人用アクセストークン
--repository
はい
リポジトリ名：owner-or-organisation/repository
--build-pull-requests
オプション
は、プルリクエストを結合した後にデプロイするように、クラウドインフラストラクチャ上のAdobe Commerceに指示します（デフォルトでは true）。
--fetch-branches
オプション
ブランチを更新した後、クラウドインフラストラクチャ上のAdobe Commerceでブランチをトラッキングしデプロイします（デフォルトでは true）。
--prune-branches
オプション
リモートに存在しないブランチを削除します（デフォルトでは true）。

その他にも様々なオプションがあり、ヘルプ オプションを使用して確認できます。

magento-cloud integration:add --help

GitHub 統合を有効にするには:

  1. 統合を有効にします。

    code language-bash 
    magento-cloud integration:add --type=github --project=<project-ID> --token=<your-GitHub-token> {--repository=USER/REPOSITORY | --repository=ORGANIZATION/REPOSITORY} [--build-pull-requests={true|false} --fetch-branches={true|false}

    例 1：個人用プライベートリポジトリに対して GitHub 統合を有効にする：

    code language-bash 
    magento-cloud integration:add --type=github --project=ov58dlacU2e --base-url=https://github.com --token=<token> --repository=myUserName/myrepo

    例 2：組織リポジトリの GitHub 統合を有効にする：

    code language-bash 
    magento-cloud integration:add --type=github --project=ov58dlacU2e --base-url=https://github.com --token=<token> --repository=Magento/teamrepo

  2. プロンプトが表示されたら、必要な情報を入力します。

  3. 戻り出力で表示された ペイロード URL をコピーします。

    code language-none 
    Created integration <integration-ID> (type: github)
Repository: myUserName/myrepo
Build PRs: yes
Fetch branches: yes
Payload URL: https://us.magento.cloud/api/projects/<project-id>/integrations/wO8a0eoamxwcg/hook

GitHub での Webhook の追加

プッシュなどのイベントをクラウド Git サーバーと通信するには、GitHub リポジトリの Webhook を作成する必要があります。

  1. GitHub リポジトリで、「設定」タブをクリックします。

  2. 左側のナビゲーションバーで、「Webhook」をクリックします。

  3. Webhook パネルで、「Webhook を追加」をクリックします。

  4. Webhook/Add Webhook フォームで、次のフィールドを編集します。

    • ペイロード URL:GitHub 統合を有効にした際に返された URL を入力します。
    • コンテンツタイプ：リストから application/json を選択します。
    • 秘密鍵：検証の秘密鍵を入力します。
    • この Webhook をトリガーにするイベントはどれですか？: すべて送信 を選択します。
    • 「アクティブ」チェックボックスを選択します。

  5. Webhook を追加 をクリックします。

統合のテスト

GitHub 統合を設定したら、magento-cloud の CLI を使用して、統合が動作していることを確認できます。

magento-cloud integration:validate

または、GitHub リポジトリに簡単な変更をプッシュしてテストできます。

  1. テストファイルを作成します。

    code language-bash 
    touch test.md

  2. 変更をコミットして GitHub リポジトリにプッシュします。

    code language-bash 
    git add . && git commit -m "Testing GitHub integration" && git push

  3. Cloud Console にログインし、コミットメッセージが表示され、プロジェクトがデプロイされていることを確認します。

統合の削除

コードに影響を与えることなく、プロジェクトから GitHub 統合を安全に削除できます。

GitHub 統合を削除するには:

  1. ターミナルから、クラウドインフラストラクチャプロジェクトのAdobe Commerceにログインします。

  2. 統合のリストを作成します。 次の手順を完了するには、GitHub 統合 ID が必要です。

    code language-bash 
    magento-cloud integration:list

  3. 統合を削除します。

    code language-bash 
    magento-cloud integration:delete <int-ID>

また、GitHub アカウントにログインし、リポジトリの「Webhook」タブで Web フックを削除することで、GitHub の統合を削除できます 設定。

recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26