Composer プロジェクト構造

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
ベストプラクティス

作成対象：

経験者
開発者

このガイドでは、グローバルリファレンスアーキテクチャ（GRA）の例で説明している separate packages option を設定および保守する方法について説明します。

前提条件

開始する前に、次の点を確認してください。

Git リポジトリがある
Composer リポジトリがある（このトピックではプライベート・パッケージ・リストをハイライト表示）
repo.magento.com リポジトリと packagist.org リポジトリをミラーリングするように Composer リポジトリを設定しました。

メイン Git プロジェクトリポジトリ

メイン Git プロジェクトリポジトリには、Composer プロジェクトのみを含める必要があります。 Composer パッケージを使用すると、その他すべてを管理できます。 Composer は依存関係によって他のすべてのパッケージをインストールするため、メインプロジェクトには次のファイル構造以外のファイルを含めないでください。

./
├─ .git/
├─ .gitignore
├─ composer.json
└─ composer.lock

次の内容を .gitignore ファイルに追加します。

/*
!/composer.json
!/composer.lock

主プロジェクトの初期化

project-<region/country/brand> という Git リポジトリを作成します。

composer.json ファイルと composer.lock ファイルを作成します。

code language-bash

code language-bash
composer create-project --no-install --repository-url=https://repo.magento.com/ magento/project-enterprise-edition project-<region/country/brand> cd <install-directory-name> printf '/*\n!/composer.json\n!/composer.lock\n!/.gitignore' > .gitignore composer config --unset version composer config name '<client>/project-<region/country/brand>' composer config description '<client> <region/country/brand> main composer project' composer config repositories.private-packagist composer https://repo.packagist.com/<client>/ composer config repositories.packagist.org false composer config --unset repositories.0 composer install git init git add --all git commit -m 'initialize project' git remote add origin git@bitbucket.org:<client>/project-<region/country/brand>.git git push -u origin master

composer create-project --no-install --repository-url=https://repo.magento.com/ magento/project-enterprise-edition project-<region/country/brand>
cd <install-directory-name>
printf '/*\n!/composer.json\n!/composer.lock\n!/.gitignore' > .gitignore
composer config --unset version
composer config name '<client>/project-<region/country/brand>'
composer config description '<client> <region/country/brand> main composer project'
composer config repositories.private-packagist composer https://repo.packagist.com/<client>/
composer config repositories.packagist.org false
composer config --unset repositories.0
composer install
git init
git add --all
git commit -m 'initialize project'
git remote add origin git@bitbucket.org:<client>/project-<region/country/brand>.git
git push -u origin master

モジュール以外のファイルを保存

app/etc/config.xml ファイルを Git リポジトリに追加します。

作成するモジュールを使用して、.htaccess、Google、Bing 認証テキストファイル、実行可能ファイル、Adobe Commerce モジュールで管理されないその他の静的ファイルなど、他のリージョンまたはブランド固有のファイルをインストールできます。

magento2-component タイプのパッケージを使用して、composer install および composer update の操作中にファイルをメイン Git リポジトリにコピーするためのファイルマッピングを作成します。

命名規則 component-environment-<region/country/brand> に従って、Git リポジトリを作成します。

code language-bash

code language-bash
`bin/magento module:enable --all cd ../ mkdir component-environment-<region/country/brand> cd component-environment-<region/country/brand> composer init --no-interaction \ --name='<client>/component-environment-<region/country/brand>' \ --description='<client> <region/country/brand> environment files' \ --type=magento2-component \ --require="magento/magento-composer-installer:*" mkdir -p app/etc cp ../project-<region/country/brand>/app/etc/config.php app/etc/ composer config -e`

bin/magento module:enable --all
cd ../
mkdir component-environment-<region/country/brand>
cd component-environment-<region/country/brand>
composer init --no-interaction \
 --name='<client>/component-environment-<region/country/brand>' \
 --description='<client> <region/country/brand> environment files' \
 --type=magento2-component \
 --require="magento/magento-composer-installer:*"
mkdir -p app/etc
cp ../project-<region/country/brand>/app/etc/config.php app/etc/
composer config -e

app/etc/config.php ファイルをマッピングとして、composer.json ファイルの extra.map 属性に追加します。

code language-json

code language-json
`{ "name": "example-client/component-environment-emea", "description": "Example client EMEA environment files", "type": "magento2-component", "require": { "magento/magento-composer-installer": "*" }, "extra": { "map": [ [ "app/etc/config.php", "app/etc/config.php" ] ] } }`

{
    "name": "example-client/component-environment-emea",
    "description": "Example client EMEA environment files",
    "type": "magento2-component",
    "require": {
        "magento/magento-composer-installer": "*"
    },
    "extra": {
        "map": [
            [
                "app/etc/config.php",
                "app/etc/config.php"
            ]
        ]
    }
}

composer.json ファイルを検証し、Git リポジトリにコミットします。

code language-bash

code language-bash
`composer validate git init git add --all git commit -m 'initialize component' git remote add origin git@bitbucket.org:<client>/component-environment-<region/country/brand>.git git push -u origin master git tag 0.1.0 -m "0.1.0" git push --tags`

composer validate
git init
git add --all
git commit -m 'initialize component'
git remote add origin git@bitbucket.org:<client>/component-environment-<region/country/brand>.git
git push -u origin master
git tag 0.1.0 -m "0.1.0"
git push --tags

メタパッケージの設定

次の Git リポジトリを作成します。
- meta-gra
- meta-<region/country/brand>

次の依存関係ツリーを設定します。

code language-tree

code language-tree
`client/project-<region/country/brand> └─ requires -> client/meta-<region/country/brand> ├─ requires -> client/component-environment-<region/country/brand> └─ requires -> client/meta-gra └─ requires -> magento/product-enterprise-edition`

client/project-<region/country/brand>
└─ requires -> client/meta-<region/country/brand>
               ├─ requires -> client/component-environment-<region/country/brand>
               └─ requires -> client/meta-gra
                              └─ requires -> magento/product-enterprise-edition

GRA メタパッケージを作成します。

code language-bash

code language-bash
`cd .. mkdir meta-gra cd meta-gra composer init --no-interaction \ --name='<client>/meta-gra' \ --description='<client> GRA meta package' \ --type=metapackage \ --require="magento/product-enterprise-edition:<exact.required.version>" git init git add --all git commit -m 'initialize meta package' git remote add origin git@bitbucket.org:<client>/meta-gra.git git push -u origin master git tag 0.1.0 -m "0.1.0" git push --tags`

cd ..
mkdir meta-gra
cd meta-gra
composer init --no-interaction \
 --name='<client>/meta-gra' \
 --description='<client> GRA meta package' \
 --type=metapackage \
 --require="magento/product-enterprise-edition:<exact.required.version>"
git init
git add --all
git commit -m 'initialize meta package'
git remote add origin git@bitbucket.org:<client>/meta-gra.git
git push -u origin master
git tag 0.1.0 -m "0.1.0"
git push --tags

ブランドメタパッケージを作成します。

code language-bash

code language-bash
cd .. mkdir meta-<region/country/brand> cd meta-<region/country/brand> composer init --no-interaction \ --name='<client>/meta-<region/country/brand>' \ --description='<client> <region/country/brand> meta package' \ --type=metapackage \ --require="<client>/component-environment-<region/country/brand>:~0.1" \ --require="<client>/meta-gra:~0.1" git init git add --all git commit -m 'initialize meta package' git remote add origin git@bitbucket.org:<client>/meta-<region/country/brand>.git git push -u origin master git tag 0.1.0 -m "0.1.0" git push --tags

cd ..
mkdir meta-<region/country/brand>
cd meta-<region/country/brand>
composer init --no-interaction \
 --name='<client>/meta-<region/country/brand>' \
 --description='<client> <region/country/brand> meta package' \
 --type=metapackage \
 --require="<client>/component-environment-<region/country/brand>:~0.1" \
 --require="<client>/meta-gra:~0.1"
git init
git add --all
git commit -m 'initialize meta package'
git remote add origin git@bitbucket.org:<client>/meta-<region/country/brand>.git
git push -u origin master
git tag 0.1.0 -m "0.1.0"
git push --tags

メインプロジェクトの依存関係管理を通じてコレクションを必要とする：

code language-bash

code language-bash
`cd ../project-<region/country/brand> rm app/etc/config.php composer remove --no-update magento/product-enterprise-edition composer require --no-update "<client>/meta-<region/country/brand>:~0.1" composer config minimum-stability alpha composer config prefer-stable true composer update git add --all git commit -m 'set up GRA dependency tree' git push origin master git tag 0.1.0 -m "0.1.0" git push --tags`

cd ../project-<region/country/brand>
rm app/etc/config.php
composer remove --no-update magento/product-enterprise-edition
composer require --no-update "<client>/meta-<region/country/brand>:~0.1"
composer config minimum-stability alpha
composer config prefer-stable true
composer update
git add --all
git commit -m 'set up GRA dependency tree'
git push origin master
git tag 0.1.0 -m "0.1.0"
git push --tags

Composer が <client>/component-environment-<region/country/brand> から app/etc/config.php ファイルをコピーしたことを確認します。

コードのデプロイ

Web サーバーでは、Composer を使用してコードをデプロイできますが、メインプロジェクトを更新することはできません。新しいデプロイメントのたびに、Composer を使用してプロジェクトを再インストールします。これにより、実稼動サーバーとテストサーバーが Git にアクセスする必要がなくなります。

他のインスタンスおよびパッケージの追加

各インスタンス（地域、ブランド、その他の一意のAdobe Commerceのインストール）は、独自の メインプロジェクト インスタンス、固有のメタパッケージ および 環境コンポーネントパッケージ を取得する必要があります。 GRA メタパッケージ はすべてのインスタンスで共有する必要があります。

次のいずれかの方法で、機能パッケージ（Adobe Commerce モジュール、テーマ、言語パック、ライブラリなど）およびサードパーティパッケージを要求する必要があります。

GRA メタパッケージ - all インスタンスへのインストール用
インスタンス固有のメタパッケージ - 1 つのブランドまたは地域へのインストール用

IMPORTANT

main または release のブランチにあるメインプロジェクトの composer.json ファイルにパッケージを必要としません。

開発の準備

開発の場合は、保守するすべてのモジュールの develop バージョンをインストールします。

ブランチ戦略に応じて、develop、qa、uat、main のブランチが存在する場合があります。各ブランチは、dev- というプレフィックスとともに Composer に存在します。そのため、develop ブランチは、バージョン dev-develop として Composer を通じて必要になる場合があります。

すべてのモジュールとプロジェクトリポジトリに develop ブランチを作成します。

code language-bash

code language-bash
cd ../component-environment-<region/country/brand> git checkout master git checkout -b develop git push -u origin develop cd ../meta-<region/country/brand> git checkout master git checkout -b develop git push -u origin develop cd ../meta-gra git checkout master git checkout -b develop git push -u origin develop cd ../project-<region/country/brand> git checkout master git checkout -b develop git push -u origin develop composer require \ "magento-services/meta-fantasy-corp:dev-develop as 0.999" \ "magento-services/meta-gra:dev-develop as 0.999" \ "magento-services/component-environment-fantasy-corp:dev-develop as 0.999"

cd ../component-environment-<region/country/brand>
git checkout master
git checkout -b develop
git push -u origin develop


cd ../meta-<region/country/brand>
git checkout master
git checkout -b develop

git push -u origin develop


cd ../meta-gra
git checkout master
git checkout -b develop
git push -u origin develop


cd ../project-<region/country/brand>
git checkout master
git checkout -b develop
git push -u origin develop


composer require \
"magento-services/meta-fantasy-corp:dev-develop as 0.999" \
"magento-services/meta-gra:dev-develop as 0.999" \
"magento-services/component-environment-fantasy-corp:dev-develop as 0.999"

前の手順では、composer.json ファイルに次の行を生成します。

code language-json

code language-json
`"require": { "magento-services/component-environment-fantasy-corp": "dev-develop as 0.999", "magento-services/meta-fantasy-corp": "dev-develop as 0.999", "magento-services/meta-gra": "dev-develop as 0.999" },`

"require": {
    "magento-services/component-environment-fantasy-corp": "dev-develop as 0.999",
    "magento-services/meta-fantasy-corp": "dev-develop as 0.999",
    "magento-services/meta-gra": "dev-develop as 0.999"
},

note important

note important
IMPORTANT
結合しないでくださいこれらの `composer.json` ファイルの変更は、実稼動ブランチに対して行われます。 `release` および `main` のブランチには、安定したバージョンのパッケージのみをインストールしてください。これらの依存関係は、`qa` のブランチと、その他の非メインブランチに対して定義できます。

IMPORTANT

結合しないでください これらの composer.json ファイルの変更は、実稼動ブランチに対して行われます。 release および main のブランチには、安定したバージョンのパッケージのみをインストールしてください。これらの依存関係は、qa のブランチと、その他の非メインブランチに対して定義できます。

recommendation-more-help

754cbbf3-3a3c-4af3-b6ce-9d34390f3a60