Exemplos de arquitetura de referência global

Este tópico descreve maneiras comuns de organizar uma base de código da GRA (arquitetura de referência global). Embora a opção pacotes separados seja preferida, algumas situações exigem uma das outras opções descritas abaixo.

Definições

Opção 1: pacotes separados

Consulte as práticas recomendadas da estrutura do projeto do Composer para configurar este método.

A maneira mais flexível de gerenciar pacotes do GRA Composer é por meio de metapackages. Os metapackages contêm apenas um arquivo composer.json, o que define outras dependências de pacote. Crie metapackages usando repositórios Private Packagist.

Projeto principal composer.json

{
    "name": "example-client/region-1",
    "description": "Example Client Region 1",
    "type": "project",
    "require": {
        "magento/product-enterprise-edition": "2.3.5",
        "example-client/meta-region-1": "~1.0"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "repositories": [
        {"type": "composer", "url": "https://repo.packagist.com/example-client/"},
        {"packagist.org": false}
    ]
}

example-client/meta-region-1 composer.json

{
    "name": "example-client/meta-region-1",
    "description": "Region 1 meta package",
    "type": "metapackage",
    "require": {
        "example-client/meta-gra": "~1.0",
        "example-client/theme-frontend-region1",
        "example-client/language-es-es",
        "ingenico/ogone-client"
    }
}

example-client/meta-gra composer.json

{
    "name": "example-client/meta-gra",
    "description": "GRA meta package",
    "type": "metapackage",
    "require": {
        "geoip2/geoip2": "~2.0",
        "magento-services/module-stackify-logger": "~1.1",
        "example-client/sap-connector",
        "example-client/service-chat",
        "example-client/store-locator"
    }
}

Cada módulo, pacote de idiomas, tema e biblioteca tem seu próprio repositório Git. Cada repositório Git é sincronizado automaticamente com o repositório do Private Packagist e gera um pacote nele, desde que haja um arquivo composer.json na raiz do repositório Git.

Opções 2: pacotes em massa

Veja abaixo um exemplo de vários módulos dentro de um único pacote do Composer.

Um pacote em massa só pode incluir pacotes do mesmo tipo. Por exemplo, se você tiver vários pacotes para módulos, temas, pacotes de idiomas e bibliotecas do Adobe Commerce, será necessário criar pacotes em massa separados para cada tipo.

A estrutura de arquivos dentro do diretório de fornecedor deve ser semelhante ao exemplo a seguir. No entanto, verifique seu projeto para ver o que deve ser incluído no repositório Git):

.
└── example-client/
    └── gra/
        └── src/
            ├── SapConnector/
            │   ├── etc/
            │   └── registration.php
            ├── ServiceChat/
            │   ├── etc/
            │   └── registration.php
            ├── StoreLocator/
            │   ├── etc/
            │   └── registration.php
            └── composer.json

O arquivo composer.json deve ter esta aparência:

{
    "name": "example-client/gra",
    "description": "GRA Modules",
    "require": {
        "magento/magento-composer-installer": "*"
    },
    "type": "magento2-module",
    "autoload": {
        "files": [
            "src/SapConnector/registration.php",
            "src/ServiceChat/registration.php",
            "src/StoreLocator/registration.php"
        ],
        "psr-4": {
            "ExampleClient\\SapConnector\\": "src/SapConnector",
            "ExampleClient\\ServiceChat\\": "src/ServiceChat",
            "ExampleClient\\StoreLocator\\": "src/StoreLocator"
        }
    }
}

Opção 3: Dividir o Git

Essa arquitetura usa quatro repositórios Git para armazenar código:

Para configurar essa opção:

Opção 4: Monorepo (recomendado)

Essa estratégia imita de perto a forma como o repositório Git do Magento Open Source funciona.

Todo o código é desenvolvido e testado em um único repositório. A automação exibe pacotes desse único repositório, que pode ser instalado em ambientes UAT e de produção usando o Composer.

A opção monorepo oferece a facilidade de trabalhar em um único repositório, além de fornecer a flexibilidade de compor instâncias com pacotes.

O controle de versão e a destilação de pacotes são feitos por automação, usando Ações do GitHub ou Ações do GitLab.

Consulte os seguintes recursos para obter mais informações sobre essa automação:

Não misture estratégias

Não é aconselhável usar uma abordagem combinada usando o Composer para pacotes GRA e o diretório app/ para pacotes de marca ou região.

Você não só obtém todas as vantagens, mas também todas as desvantagens de ambos os métodos. Você deve escolher um ou outro (Git ou Composer) para funcionar de maneira ideal.

Soluções a serem evitadas