文件Commerce實施行動手冊

Composer專案結構

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

建立對象：

  • 經驗豐富
  • 開發人員

本指南說明如何設定及維護全域參考架構(GRA)範例中說明的個別套件選項。

必要條件

開始之前，請先確認下列事項：

  • 您有Git存放庫
  • 您有Composer存放庫（本主題重點說明Private Packagist）
  • 您已將Composer存放庫設定為映象repo.magento.com和packagist.org存放庫

主要Git專案存放庫

主要Git專案存放庫應僅包含Composer專案。 您可以使用Composer套件管理其他所有專案。 主要專案絕不應該包含下列檔案結構以外的任何內容，因為Composer會透過相依性安裝所有其他套件：

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

將下列內容新增至.gitignore檔案：

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

初始化主要專案

  1. 建立名為project-<region/country/brand>的Git存放庫。

  2. 建立composer.json和composer.lock檔案：

    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

儲存非模組檔案

  1. 將app/etc/config.xml檔案新增至Git存放庫。

    您可以使用要建立的模組來安裝其他區域或品牌特定檔案，例如.htaccess、Google或Bing驗證文字檔、可執行檔，或其他未由Adobe Commerce模組管理的靜態檔案。

    使用magento2-component型別套件建立檔案對應，以在composer install和composer update作業期間將檔案複製到主要Git存放庫。

  2. 建立遵循命名慣例component-environment-<region/country/brand>的Git存放庫：

    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

  3. 將app/etc/config.php檔案新增為composer.json檔案的extra.map屬性中的對應：

    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"
            ]
        ]
    }
}

  4. 驗證composer.json檔案並將其提交至Git存放庫：

    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

設定中繼

  1. 建立下列Git存放庫：

    • meta-gra
    • meta-<region/country/brand>

  2. 設定下列相依性樹狀結構：

    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

  3. 建立GRA中繼資料：

    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

  4. 建立品牌中繼資料：

    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

  5. 需要透過主要專案中的相依性管理進行收集：

    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

  6. 驗證Composer是否從<client>/component-environment-<region/country/brand>複製app/etc/config.php檔案。

部署程式碼

在Web伺服器上，您可以使用Composer部署程式碼，但無法更新主要專案。 使用撰寫器重新安裝專案並搭配每個新部署，免除生產及測試伺服器存取Git的需求。

新增其他執行個體和套件

每個執行個體(地區、品牌或其他獨特的Adobe Commerce安裝)應該有自己的​ 主要專案 ​執行個體、特定中繼套件 ​和​ 環境元件套件。 GRA中繼資料 ​應在所有執行個體之間​ 共用。

下列任一專案應需要功能套件(例如Adobe Commerce模組、主題、語言套件和程式庫)和協力廠商套件：

  • GRA Metapackage — 安裝在​ 所有 ​執行個體上
  • 執行個體專屬中繼套件 — 適用於安裝在單一品牌或區域上
IMPORTANT
不需要位於main或release分支上主要專案的composer.json檔案中的封裝。

準備開發

若要進行開發，請安裝您維護之所有模組的develop版本。

根據您的分支策略，您可能會有develop、qa、uat和main個分支。 每個分支都存在於具有dev-首碼的撰寫器中。 因此develop分支必須透過Composer做為版本dev-develop。

  1. 在所有模組和專案存放庫中建立develop個分支。

    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"

    上一步會在composer.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"
},
    note important
    IMPORTANT
    請勿將這composer.json個檔案變更合併 ​至您的生產分支。 僅在release和main分支上安裝穩定版本的套件。 您可以為qa個分支和其他非主要分支定義這些相依性。
recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60