[Tony Evers, 수석 기술 설계자, Adobe 제공]{class="badge informative" title="토니 에버스의 기고문"}

Monorepo 글로벌 참조 아키텍처 패턴

이 정보는​에 적용됩니다.

이 안내서에서는 Monorepo GRA(글로벌 참조 아키텍처) 패턴을 사용하여 Adobe Commerce을 설정하는 방법을 설명합니다.

모노레포 GRA 패턴에는 모든 공통 사용자 정의를 호스팅하기 위한 단일 Git 저장소가 포함됩니다. 이 단일 Git 저장소는 Composer를 통해 별도의 Composer 패키지로 표시됩니다.

{align="center"}

이 패턴의 장단점

장점:

단점:

개별 패키지 GRA 패턴으로 Adobe Commerce 설정

디렉터리 구조

개별 패키지 GRA 패턴이 있는 전체 Adobe Commerce 설치의 최종 디렉터리 구조는 다음 디렉터리 구조를 가집니다.

.
├── app/
│   └── etc/
│       └── config.php
├── packages/
│   └── ...
├── composer.json
└── composer.lock

프로덕션 Git 저장소에는 다음과 같은 디렉터리 구조가 있습니다.

.
├── app/
│   └── etc/
│       └── config.php
├── composer.json
└── composer.lock

차이점은 프로덕션 인스턴스가 Composer에서 설치되고, 여기서 모노레포는 패키지 디렉터리 내에 모든 패키지의 자체 복사본을 보유한다는 것입니다.

프로덕션 저장소 준비

Brand X의 웹 스토어를 나타내는 첫 번째 Adobe Commerce 인스턴스에 대한 저장소를 만듭니다.

mkdir gra-monorepo-brand-x
cd gra-monorepo-brand-x
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition .
git init
git remote add origin git@github.com:AntonEvers/gra-monorepo-brand-x.git
git add composer.json composer.lock
git commit -m 'initialize Brand X repository'
git push -u origin main

bin/magento setup:install(으)로 Adobe Commerce을 설치합니다. 결과 app/etc/config.php 및 작성기 파일을 커밋합니다. Composer는 다른 모든 것을 관리하므로 Git에 다른 것이 없어야 합니다.

모노레포 저장소 준비

Monorepo 저장소는 동일한 단계로 시작합니다.

mkdir gra-monorepo
cd gra-monorepo
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition .

bin/magento setup:install(으)로 Adobe Commerce 설치, 커밋 및 푸시.

git init
git remote add origin git@github.com:AntonEvers/gra-monorepo.git
git add composer.json composer.lock app/etc/config.php
git commit -m 'initialize monorepo GRA development repository'
git push -u origin main

모노레포 개발 준비

모노레포 개발의 경우 composer.json 파일을 다음과 같이 변경합니다.

다음 Git diff는 깔끔한 Adobe Commerce 설치와 위에서 언급한 변경 사항의 차이를 보여줍니다.

@@ -1,6 +1,6 @@
 {
-    "name": "magento/project-enterprise-edition",
-    "description": "eCommerce Platform for Growth (Enterprise Edition)",
+    "name": "antonevers/gra-monorepo",
+    "description": "Monorepo repository for Global Reference Architecture development",
     "type": "project",
     "license": [
         "proprietary"
@@ -15,11 +15,8 @@
         "preferred-install": "dist",
         "sort-packages": true
     },
-    "version": "2.4.7-p3",
     "require": {
-        "magento/product-enterprise-edition": "2.4.7-p3",
-        "magento/composer-dependency-version-audit-plugin": "~0.1",
-        "magento/composer-root-update-plugin": "^2.0.4"
+        "antonevers/gra-meta-brand-x": "self.version"
     },
     "autoload": {
         "exclude-from-classmap": [
@@ -69,16 +66,33 @@
             "Magento\\Tools\\Sanity\\": "dev/build/publication/sanity/Magento/Tools/Sanity/"
         }
     },
-    "minimum-stability": "stable",
+    "minimum-stability": "dev",
     "prefer-stable": true,
     "repositories": [
         {
+            "type": "path",
+            "url": "packages/*/*",
+            "options": {
+                "versions": {
+                    "antonevers/gra-meta-brand-x": "1.4.x-dev",
+                    "antonevers/gra-meta-foundation": "1.4.x-dev",
+                    "antonevers/gra-component-foundation": "1.4.x-dev",
+                    "antonevers/module-gra": "1.4.x-dev",
+                    "antonevers/module-3rdparty": "1.4.x-dev",
+                    "antonevers/module-local": "1.4.x-dev"
+                }
+            }
+        },
+        {
             "type": "composer",
             "url": "https://repo.magento.com/"
         }
     ],
     "extra": {
-        "magento-force": "override"
+        "magento-force": "override",
+        "branch-alias": {
+            "dev-main": "1.4.x-dev"
+        }
     }
 }

메타패키지 사용

GitHub의 AntonEvers/gra-meta-foundation에서 예제 코드를 다운로드하여 이 예제에 사용된 메타패키지 및 샘플 모듈을 가져옵니다.

작성기 메타패키지는 여러 작성기 패키지를 단일 패키지로 묶습니다. 메타패키지가 필요한 경우 Composer를 통해 번들로 제공되는 모든 패키지는 메타패키지의 필수 섹션에 자동으로 설치됩니다.

이 예에는 두 개의 메타패키지가 있습니다.

브랜드 메타패키지에는 기초 메타패키지가 필요합니다. 브랜드 메타패키지가 필요한 경우 기초 메타패키지도 자동으로 필요합니다. 메타패키지의 두 composer.json 파일을 참조하여 관련 방법을 확인하십시오.

antonevers/gra-meta-brand-x:

{
    "name": "antonevers/gra-meta-brand-x",
    "type": "metapackage",
    "license": [
        "OSL-3.0",
        "AFL-3.0"
    ],
    "require": {
        "antonevers/gra-meta-foundation": "^1.4",
        "antonevers/module-local": "^1.4"
    }
}

antonevers/gra-meta-foundation:

{
    "name": "antonevers/gra-meta-foundation",
    "type": "metapackage",
    "license": [
        "OSL-3.0",
        "AFL-3.0"
    ],
    "require": {
        "antonevers/gra-component-foundation": "^1.4",
        "antonevers/module-gra": "^1.4",
        "antonevers/module-3rdparty": "^1.4",
        "magento/composer-dependency-version-audit-plugin": "~0.1",
        "magento/composer-root-update-plugin": "^2.0.4",
        "magento/product-enterprise-edition": "2.4.7-p3"
    }
}

메타패키지는 함께 속한 코드를 구성하는 좋은 방법입니다. 메타패키지를 사용하여 지역별, 글로벌, 브랜드별 또는 자신에게 적합한 그룹화된 패키지 그룹을 정의합니다. Adobe Commerce의 여러 설치를 유지 관리하는 경우 matappackages는 패키지가 예상되는 컨텍스트를 정의하는 안전하고 다양한 방법을 제공합니다.

메타패키지가 packages 디렉터리 내의 모노레포에 있습니다. vendor의 디렉터리 구조가 미러링되었습니다.

.
├── packages/
│   └── antonevers
│       ├── gra-meta-brand-x
│       │   └── composer.json
│       └── gra-meta-foundation
│           └── composer.json
├── composer.json
└── composer.lock

모듈 추가 및 개발

packages 디렉터리에 모노포에 있는 모듈이 있습니다. 이렇게 하면 Composer가 경로 유형 저장소를 통해 해당 경로를 찾을 수 있습니다.

GitHub의 AntonEvers/gra-meta-foundation에서 예제 코드를 다운로드하여 이 예제에 사용된 메타패키지 및 샘플 모듈을 가져옵니다.

.
├── packages/
│   └── antonevers
│       ├── gra-meta-brand-x
│       ├── gra-meta-foundation
│       ├── module-3rdparty
│       ├── module-gra
│       └── module-local
├── composer.json
└── composer.lock

필요한 경우 packages 디렉터리 내에 여러 네임스페이스를 사용할 수 있습니다.

개발은 패키지 디렉터리에서 수행됩니다. composer update을(를) 실행하면 packages 디렉터리 내의 패키지에 대한 심볼릭 링크가 vendor 디렉터리에 생성됩니다. 이렇게 하면 코드가 Adobe Commerce 설치의 일부가 됩니다.

bin/magento module:enable --all 또는 특정 모듈에 대해서만 실행하여 추가된 모듈을 사용하도록 설정하십시오.

이제 3개의 샘플 모듈이 설치되고 작동하는 Adobe Commerce 설치 작업이 수행되어야 합니다. 다음 명령을 실행하여 모듈이 설치되어 있고 작동하는지 확인할 수 있습니다.

bin/magento test:gra
bin/magento test:3rdparty
bin/magento test:local

자동화된 패키지 생성 달성

자동화된 패키지 생성을 위해서는 여러 가지 옵션이 있습니다. 일부 옵션은 다음과 같습니다.

개인 패키지 목록은(는) Git monorepo에서 패키지를 인식하도록 자동화하고 Composer를 통해 표시합니다. 이 안내서는 Adobe Commerce과 호환되며, 빠르고, 유지 관리가 용이하며 오류가 발생하기 쉽습니다. 따라서 이 안내서는 Private Packagist 옵션에 중점을 둡니다.

개인 패키지 관리자를 설정하는 방법을 설명하는 것은 이 안내서의 범위를 벗어납니다. docs을(를) 참조하십시오.

조직 동기화를 설정하고 Git 저장소가 자동으로 개인 패키지 관리자로 동기화되면 패키지를 모노레포로 만들 수 있습니다.

먼저 패키지 탭으로 이동하여 모노레포를 찾습니다.

{align="center"}

Monorepo 패키지를 클릭하고 세부 정보 화면에서 "편집"을 클릭하면 다음 페이지로 이동합니다.

첫 번째 입력 필드 아래에는 "다중 패키지 저장소 만들기"라는 링크가 있습니다. 이 링크를 클릭합니다.

Monorepo 내에서 작성기 패키지를 찾을 수 있는 위치를 정의합니다. 이 예제에서 위치는 packages/**/composer.json입니다. Private Packagist가 추출할 패키지를 검색하는 위치를 제한하거나 확장합니다.

The packages tab will show all found packages after saving, and the monorepo itself will no longer be visible as a Composer package:

A version is created in Composer for each package inside the monorepo, for every tag or branch that is created on the monorepo in Git.

Install the packages to the production environment

Follow the instructions from Private Packagist to add Private Packagist as a composer repository. Private Packagist can and should be used as a mirror for all your Composer repositories and Git repositories, including packagist.org. That way credentials do not have to be shared with developers and you have complete control over each package. This example does not follow this best practice as it would expose the Adobe Commerce codebase publicly.

Download GRA Monorepo Brand X from GitHub to see an example of a production store.

In the production store, there is no packages directory, and all packages are installed through Composer. The only package that is required is:

    "require": {
        "antonevers/gra-meta-brand-x": "^1.0"
    },

Yet all of Adobe Commerce and the entire GRA is installed through this metapackage’s requirements.

Versioning

All packages in the monorepo receive the same version as the monorepo itself. Think of it as publishing new versions of the entire application. On production, however, you can install a mix of packages from different monorepo versions.

Ephemeral environments

If you use ephemeral environments or you plan to use them, the monorepo is an excellent choice. Every version and branch of the monorepo contains all Adobe Commerce, third party and custom module files. With a complete installation in every branch, it is possible to run every type of test including functional tests. With other GRA setups such as the separate packages or bulk packages GRA, you would first need to build a working Adobe Commerce environment before being able to run functional tests. From a DevOps perspective, monorepo makes it much simpler.

코드 예

The code examples of this article have been combined in a set of Git repositories, which you can use to play around with the proof of concept.