Ejemplos de arquitectura de referencia global

En este tema se describen formas comunes de organizar una base de código de arquitectura de referencia global (GRA). Aunque se prefiere la opción separar paquetes, algunas situaciones requieren una de las otras opciones que se describen a continuación.

Definiciones

Opción 1: separar los paquetes

Consulte las prácticas recomendadas en la estructura del proyecto Composer para configurar este método.

La forma más flexible de administrar los paquetes del Compositor de GRA es a través de metapaquetes. Los metapaquetes sólo contienen un archivo de composer.json, que define otras dependencias de paquetes. Cree metapaquetes usando repositorios de Packagist privado.

Proyecto 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, paquete de idioma, tema y biblioteca tiene su propio repositorio de Git. Cada repositorio de Git se sincroniza automáticamente con el repositorio de Private Packagist y genera un paquete allí siempre y cuando haya un archivo composer.json en la raíz del repositorio de Git.

Opciones 2: Paquetes en bloque

A continuación se muestra un ejemplo de varios módulos dentro de un mismo paquete de Composer.

Un paquete masivo solo puede incluir paquetes del mismo tipo. Por ejemplo, si tiene varios paquetes para módulos, temáticas, paquetes de idiomas y bibliotecas de Adobe Commerce, debe crear paquetes por lotes independientes para cada tipo.

La estructura de archivos dentro del directorio del proveedor debe ser similar al siguiente ejemplo. Sin embargo, compruebe el proyecto para ver qué debe incluirse en el repositorio Git):

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

El archivo de composer.json debe tener este aspecto:

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

Opción 3: Dividir Git

Esta arquitectura utiliza cuatro repositorios Git para almacenar código:

Para configurar esta opción:

Opción 4: Monorepo (recomendado)

Esta estrategia imita de cerca la forma en que funciona el repositorio Git de Magento Open Source.

Todo el código se desarrolla y prueba en un único repositorio. La automatización destila paquetes de este único repositorio, que se puede instalar en entornos UAT y de producción mediante Composer.

La opción monorepo le ofrece la facilidad de trabajar en un único repositorio, a la vez que proporciona la flexibilidad de componer instancias con paquetes.

Las versiones y la destilación de paquetes se realizan mediante automatización, con acciones de GitHub o acciones de GitLab.

Consulte los siguientes recursos para obtener más información sobre esta automatización:

No mezclar estrategias

No se recomienda utilizar un método combinado con Composer para paquetes GRA y el directorio app/ para paquetes de marca o región.

No solo obtienes todas las ventajas, sino también todas las desventajas de ambos métodos. Debe elegir una o la otra (Git o Composer) para trabajar de forma óptima.

Soluciones que se deben evitar