DocumentaçãoCommerceManual de implementação

Estrutura de projeto do compositor

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

Criado para:

  • Experiente
  • Desenvolvedor

Este guia descreve como configurar e manter a opção de pacotes separados descrita nos exemplos de arquitetura de referência global (GRA).

Pré-requisitos

Antes de começar, verifique o seguinte:

  • Você tem um repositório Git
  • Você tem um repositório do Composer (este tópico destaca a Lista de pacotes privados)
  • Você configurou o repositório do Composer para espelhar os repositórios repo.magento.com e packagist.org

Repositório de projeto Git principal

O repositório principal do projeto Git deve conter apenas um projeto do Composer. Você pode gerenciar tudo mais com os pacotes do Composer. O projeto principal nunca deve conter nada além da seguinte estrutura de arquivo, pois o Composer instala todos os outros pacotes por meio de dependências:

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

Adicionar o conteúdo a seguir ao arquivo .gitignore:

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

Inicializar o projeto principal

  1. Crie um repositório Git chamado project-<region/country/brand>.

  2. Criar composer.json e composer.lock arquivos:

    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

Salvar arquivos que não são do módulo

  1. Adicione o arquivo app/etc/config.xml ao repositório Git.

    Você pode usar o módulo que vai criar para instalar outros arquivos de região ou específicos da marca, como .htaccess, arquivos de texto de autenticação do Google ou Bing, executáveis ou outros arquivos estáticos que não são gerenciados por módulos do Adobe Commerce.

    Use pacotes do tipo magento2-component para criar um mapeamento de arquivo para copiar arquivos para o repositório Git principal durante as operações composer install e composer update.

  2. Crie um repositório Git que siga a convenção de nomenclatura component-environment-<region/country/brand>:

    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. Adicione o arquivo app/etc/config.php como um mapeamento no atributo extra.map de seu arquivo composer.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"
            ]
        ]
    }
}

  4. Valide o arquivo composer.json e confirme-o no repositório 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

Configurar metapackages

  1. Crie os seguintes repositórios Git:

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

  2. Configure a seguinte árvore de dependência:

    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. Crie o metapacote 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. Crie o metapackage da marca:

    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. Exigir a coleção por meio do gerenciamento de dependências no projeto principal:

    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. Verifique se o Composer copiou o arquivo app/etc/config.php de <client>/component-environment-<region/country/brand>.

Implantar código

No servidor Web, é possível implantar o código usando o Composer, mas não é possível atualizar o projeto principal. Reinstale o projeto usando o Composer com cada nova implantação, o que elimina o requisito para que os servidores de produção e teste tenham acesso ao Git.

Adicionar outras instâncias e pacotes

Cada instância (região, marca ou outra instalação exclusiva do Adobe Commerce) deve obter sua própria instância do projeto principal, metapackage específico e pacote de componentes do ambiente. O metapackage de GRA deve ser compartilhado em todas as instâncias.

Pacotes funcionais (como módulos do Adobe Commerce, temas, pacotes de idiomas e bibliotecas) e pacotes de terceiros devem ser exigidos pelo:

  • Metapackage de GRA—Para instalação em todas instâncias
  • metapackage específico da instância—Para instalação em uma única marca ou região
IMPORTANT
Não exigir pacotes no arquivo composer.json do projeto principal nas ramificações main ou release.

Preparação para o desenvolvimento

Para desenvolvimento, instale as versões develop de todos os módulos que você mantém.

Dependendo da sua estratégia de ramificação, você pode ter develop, qa, uat e main ramificações. Cada ramificação existe no Composer com um prefixo dev-. Portanto, a ramificação develop pode ser exigida pelo Composer como versão dev-develop.

  1. Criar develop ramificações em todos os módulos e repositórios do projeto.

    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"

    A etapa anterior gera as seguintes linhas no arquivo 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
    Não mesclar essas composer.json alterações de arquivo na ramificação de produção. Instale somente versões estáveis de pacotes nas ramificações release e main. Você pode definir essas dependências para qa ramificações e outras ramificações não principais.
recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60