You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/git-vs-composer-install.md
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
-
#Git vs Composer Installation of Magento with MFTF
1
+
#Git vs Composer Installation of Magento with MFTF
2
2
3
3
4
-
###GitHub Installation
4
+
###GitHub Installation
5
5
6
6
If you are planning on contributing a PR to the Magento 2 codebase, you can download Magento 2 from GitHub. Contribution to the codebase is done using the 'fork and pull' model where contributors maintain their own fork of the repo. This repo is then used to submit a pull request to the base repo.
Composer install downloads released packages of Magento 2 from the composer repo [https://repo.magento.com](https://repo.magento.com).
14
14
@@ -24,13 +24,13 @@ After installing your Magento project in either of the above ways, the composer
24
24
If you want to contribute a PR into MFTF codebase, you will need to install MFTF in the [Standalone] mode.
25
25
26
26
27
-
###Managing modules - Composer vs GitHub
27
+
###Managing modules - Composer vs GitHub
28
28
29
-
####Via GitHub:
29
+
####Via GitHub:
30
30
31
31
Cloning Magento 2 git repository is a way of installing when you don't have to worry frequently about matching the codebase with production. Your version control system generally holds and manages your `app/code` folder and you can do manual ad-hoc development here.
32
32
33
-
####Via composer:
33
+
####Via composer:
34
34
35
35
Magento 2 advocates the use of composer for managing modules. When you install a module through composer, it is added to `vendor/<vendor-name>/<module>`
36
36
@@ -39,11 +39,11 @@ If you are developing your own module or adding MFTF tests to the module, you sh
39
39
If you want to distribute the module and its tests, you can initialize a git repo and create a [composer package](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/package/package_module.html). In this way others will be able to download and install your module and access your tests as a composer package, in their `<vendor>` folder.
40
40
41
41
42
-
###MFTF test artifacts location
42
+
###MFTF test artifacts location
43
43
44
-
- For GitHub installation, MFTF test artifacts are located at `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to create new tests or maintain existing ones.
44
+
- For GitHub installation, MFTF test materials are located at `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to create new tests or maintain existing ones.
45
45
46
-
- For Composer based installation, MFTF test artifacts are located at `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to run tests fetched by Composer.
46
+
- For Composer based installation, MFTF test materials are located at `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to run tests fetched by Composer.
47
47
48
48
The file structure under both paths is the same as below:
49
49
@@ -64,17 +64,17 @@ The file structure under both paths is the same as below:
64
64
```
65
65
66
66
67
-
###How ModuleResolver reads modules
67
+
###How ModuleResolver reads modules
68
68
69
69
In either of the installations, all tests and test data are read and merged by MFTF's ModuleResolver in the order indicated below:
There are no differences from MFTF's perspective between having the test artifacts in `app/code` or in `/vendor` as it reads artifacts from both paths. It works the same. Composer based install may benefit teams when there's a need to match file systems in dev and production.
77
+
There are no differences from MFTF's perspective between having the test materials in `app/code` or in `/vendor` as it reads artifacts from both paths. It works the same. Composer based install may benefit teams when there's a need to match file systems in dev and production.
78
78
79
79
If you are a contributing developer with an understanding of Git and Composer commands, you can choose the GitHub installation method instead.
0 commit comments