文档Commerce实施行动手册

Composer项目结构

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

创建对象：

  • 有经验的
  • 开发人员

本指南介绍如何设置和维护全局参考体系结构(GRA)示例中描述的单独的包选项。

先决条件

在开始之前，请验证以下各项：

  • 您有一个Git存储库
  • 您拥有Composer存储库（本主题重点介绍私有包程序）
  • 您已配置编辑器存储库以镜像repo.magento.com和packagist.org存储库

主Git项目存储库

主Git项目存储库应仅包含编辑器项目。 您可以使用编辑器包管理其他所有内容。 主项目绝不应包含除以下文件结构之外的任何其他内容，因为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. 创建GRAmetapackage：

    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. 验证编辑器是否从<client>/component-environment-<region/country/brand>复制了app/etc/config.php文件。

部署代码

在Web服务器上，您可以使用编辑器部署代码，但无法更新主项目。 在每次新部署时使用编辑器重新安装项目，这消除了生产和测试服务器访问Git的要求。

添加其他实例和包

每个实例(地区、品牌或其他唯一的Adobe Commerce安装)都应获得自己的​ 主项目 ​实例、特定中继 ​和​ 环境组件包。 GRA中继 ​应在所有实例中​ 共享。

以下任一方式均需要功能包(例如Adobe Commerce模块、主题、语言包和库)和第三方包：

  • GRA中继 — 用于在​ 所有 ​实例上安装
  • 特定于实例的中继包 — 用于安装在单个品牌或区域上
IMPORTANT
在main或release分支上的主项目的composer.json文件中不需要包。

准备开发

对于开发，请安装您维护的所有模块的develop版本。

根据您的分支策略，您可能具有develop、qa、uat和main分支。 每个分支都存在于前缀为dev-的编辑器中。 因此，可以通过Composer以版本dev-develop的形式需要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