From 872d93b1f106dab564b3b2cd88e39b14aa124bd1 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 15 Aug 2019 13:46:50 -0500 Subject: [PATCH 01/11] MAGEDOC-4042: Added examples to the Composer install topic --- guides/v2.3/install-gde/composer.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/guides/v2.3/install-gde/composer.md b/guides/v2.3/install-gde/composer.md index 8c039fc88da..b3bfb3aa443 100644 --- a/guides/v2.3/install-gde/composer.md +++ b/guides/v2.3/install-gde/composer.md @@ -49,6 +49,35 @@ To get the Magento metapackage: See [troubleshooting]({{page.baseurl}}/install-gde/trouble/tshoot_composer-fail.html) for help with more errors. + {:.bs-callout-info} + {{site.data.var.ee}} customers can access patches two weeks before the General Availability (GA) date. + +### Example - Minor release + +Minor releases contain new features, quality fixes, and security fixes. Use Composer to download a specific minor release. For example, to download the {{site.data.var.ee}} 2.3.0 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0 +``` + +### Example - Quality patch + +Quality patches primarily contain functional _and_ security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to download the {{site.data.var.ee}} 2.3.3 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.3 +``` + +### Example - Security patch + +Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. + +Security patches use the Composer naming convention `2.3.2-px`. Use Composer to download a security patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.2-p1 +``` + ## Set file permissions You must set read-write permissions for the web server group before you install the Magento software. This is necessary so that the Setup Wizard and command line can write files to the Magento file system. From a0ec24fb6adadc8df855593730eedd9780891f84 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 15 Aug 2019 13:49:56 -0500 Subject: [PATCH 02/11] MAGEDOC-4042: Specified which patches can be accessed early --- guides/v2.3/install-gde/composer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/v2.3/install-gde/composer.md b/guides/v2.3/install-gde/composer.md index b3bfb3aa443..f43c61391b0 100644 --- a/guides/v2.3/install-gde/composer.md +++ b/guides/v2.3/install-gde/composer.md @@ -50,7 +50,7 @@ To get the Magento metapackage: See [troubleshooting]({{page.baseurl}}/install-gde/trouble/tshoot_composer-fail.html) for help with more errors. {:.bs-callout-info} - {{site.data.var.ee}} customers can access patches two weeks before the General Availability (GA) date. + {{site.data.var.ee}} customers can access 2.3.x patches two weeks before the General Availability (GA) date. ### Example - Minor release From 6b7f2a0253d0425aa036647a7db69a00d909bef2 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 15 Aug 2019 15:27:15 -0500 Subject: [PATCH 03/11] MAGEDOC-4202: Cleanup upgrade topic and move examples to an include --- guides/v2.3/comp-mgr/cli/cli-upgrade.md | 194 ++++++++++++------------ guides/v2.3/install-gde/composer.md | 26 +--- 2 files changed, 98 insertions(+), 122 deletions(-) diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index 8d31417e827..d0d6fa32925 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -36,93 +36,93 @@ Complete the following prerequisites to prepare your environment before starting {: .bs-callout-info } Optionally, you can create a [custom maintenance mode page]. -## Upgrade using the command line {#upgrade-cli-upgr} - Using the more manual process of upgrading via the command line allows you to track and control exactly what is being changed in the upgrade. -### Backup `composer.json` +## Manage packages -Backup the existing `composer.json` file in the Magento installation directory. +{:.bs-callout-info} +See the examples at the end of this section for help specifying different release levels. For example, minor release, quality patch, and security patch. {{site.data.var.ee}} customers can access 2.3.x patches two weeks before the General Availability (GA) date. -### Manage packages +1. Backup the `composer.json` file. -Specify needed packages and remove any unneeded ones before proceeding with the upgrade. + ```bash + cp composer.json composer.json.bak + ``` -#### Deactivate the {{ ce }} update (for edition upgrade only) +1. Add or remove specific packages based on your needs. -_Optional_—If you are upgrading from {{ ce }} to {{ ee }}, deactivate the {{ ce }} update: +1. Deactivate the {{ ce }} update (for edition upgrade only). _Optional_—If you are upgrading from {{ ce }} to {{ ee }}, deactivate the {{ ce }} update: -```bash -composer remove magento/product-community-edition --no-update -``` + ```bash + composer remove magento/product-community-edition --no-update + ``` -#### Specify Magento packages +1. Indicate the Magento packages, both the edition (`community` or `enterprise`) and the version (`{{ page.guide_version }}.3`), that you want to upgrade to. -Indicate the Magento packages, both the edition (`community` or `enterprise`) and the version (`{{ page.guide_version }}.3`), that you want to upgrade to. + _{{ ce }}_: -_{{ ce }}_: + `` `bash + composer require magento/product-community-edition={{ page.guide_version }}.3 --no-update + ``` -```bash -composer require magento/product-community-edition={{ page.guide_version }}.3 --no-update -``` + _{{ ee }}_: -_{{ ee }}_: + ```bash + composer require magento/product-enterprise-edition={{ page.guide_version }}.3 --no-update + ``` -```bash -composer require magento/product-enterprise-edition={{ page.guide_version }}.3 --no-update -``` +
+ To see the full list of available {{ page.guide_version }} version: -
-To see the full list of available {{ page.guide_version }} version: + _Magento Open Source_: -_Magento Open Source_: + ```bash + composer show magento/product-community-edition {{ page.guide_version }}.* --all | grep -m 1 versions + ``` -```bash -composer show magento/product-community-edition {{ page.guide_version }}.* --all | grep -m 1 versions -``` + _Magento Commerce_: -_Magento Commerce_: + ```bash + composer show magento/product-enterprise-edition {{ page.guide_version }}.* --all | grep -m 1 versions + ``` -```bash -composer show magento/product-enterprise-edition {{ page.guide_version }}.* --all | grep -m 1 versions -``` +
-
+1. Specify additional packages. -#### Specify additional packages + ```bash + composer require --dev allure-framework/allure-phpunit:~1.2.0 friendsofphp/php-cs-fixer:~2.14.0 lusitanian/oauth:~0.8.10 magento/magento-coding-standard:~3.0.0 magento/magento2-functional-testing-framework:2.4.3 pdepend/pdepend:2.5.2 phpmd/phpmd:@stable phpunit/phpunit:~6.5.0 sebastian/phpcpd:~3.0.0 squizlabs/php_codesniffer:~3.4.0 --sort-packages --no-update + ``` -```bash -composer require --dev allure-framework/allure-phpunit:~1.2.0 friendsofphp/php-cs-fixer:~2.14.0 lusitanian/oauth:~0.8.10 magento/magento-coding-standard:~3.0.0 magento/magento2-functional-testing-framework:2.4.3 pdepend/pdepend:2.5.2 phpmd/phpmd:@stable phpunit/phpunit:~6.5.0 sebastian/phpcpd:~3.0.0 squizlabs/php_codesniffer:~3.4.0 --sort-packages --no-update -``` +1. Remove unused packages. -#### Remove unused packages + If you are upgrading from 2.2.x to 2.3.x, remove unused packages with the following command. It is not needed if you are upgrading from 2.3.x. -If you are upgrading from 2.2.x to 2.3.x, remove unused packages with the following command. -It is not needed if you are upgrading from 2.3.x. + ```bash + composer remove --dev sjparkinson/static-review fabpot/php-cs-fixer --no-update + ``` -```bash -composer remove --dev sjparkinson/static-review fabpot/php-cs-fixer --no-update -``` +1. Update `autoload`. -### Update `autoload` + Open `composer.json` and edit the `"autoload": "psr-4"` section to include `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"`: -Open `composer.json` and edit the `"autoload": "psr-4"` section to include `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"`: + ```json + "autoload": { + "psr-4": { + "Magento\\Framework\\": "lib/internal/Magento/Framework/", + "Magento\\Setup\\": "setup/src/Magento/Setup/", + "Magento\\": "app/code/Magento/", + "Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/" + }, + //... + } + ``` -```json -"autoload": { - "psr-4": { - "Magento\\Framework\\": "lib/internal/Magento/Framework/", - "Magento\\Setup\\": "setup/src/Magento/Setup/", - "Magento\\": "app/code/Magento/", - "Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/" - }, - //... -} -``` +{% include install/composer-examples.md %} -### Modify the Magento updater +## (_Optional)_ Modify the Magento updater -_Optional_—If the Magento updater is installed, modify it (it is located in the `update/` directory): +If the Magento updater is installed, modify it (it is located in the `update/` directory): 1. Backup the `update/` directory. 2. Create a Composer project. @@ -155,67 +155,67 @@ _Optional_—If the Magento updater is installed, modify it (it is located in th rm -rf temp_dir ``` -### Update metadata +## Update metadata -Update the `"name"`, `"version"`, and `"description"` fields in the `composer.json` file as needed. +1. Update the `"name"`, `"version"`, and `"description"` fields in the `composer.json` file as needed. -{: .bs-callout-info } -Updating the metadata in `composer.json` file is entirely superficial, not functional. + {: .bs-callout-info } + Updating the metadata in `composer.json` file is entirely superficial, not functional. -### Apply updates +1. Apply updates. -```bash -composer update -``` + ```bash + composer update + ``` -### Clean the Magento cache +1. Clean the Magento cache. -After applying an update, you must clean the cache. + ```bash + bin/magento cache:clean + ``` -```bash -bin/magento cache:clean -``` +## Clean up -### Manually clear caches and generated content +Manually clear caches and generated content. -Clear the `var/` and `generated/` subdirectories: +1. Clear the `var/` and `generated/` subdirectories: -```bash -rm -rf var/cache/* -``` + ```bash + rm -rf var/cache/* + ``` -```bash -rm -rf var/page_cache/* -``` + ```bash + rm -rf var/page_cache/* + ``` -```bash -rm -rf generated/code/* -``` + ```bash + rm -rf generated/code/* + ``` -{: .bs-callout-info } -If you use a cache storage other than the filesystem, such as Redis or Memcached, you must manually clear the cache there too. + {: .bs-callout-info } + If you use a cache storage other than the filesystem, such as Redis or Memcached, you must manually clear the cache there too. -### Update the database schema and data +1. Update the database schema and data. -```bash -bin/magento setup:upgrade -``` + ```bash + bin/magento setup:upgrade + ``` -### Disable maintenance mode +1. Disable maintenance mode. -```bash -bin/magento maintenance:disable -``` + ```bash + bin/magento maintenance:disable + ``` -### Restart Varnish +1. Restart Varnish. -_Optional_—If you use Varnish for page caching, restart it: + _Optional_—If you use Varnish for page caching, restart it: -```bash -service varnish restart -``` + ```bash + service varnish restart + ``` -### Check your work +## Check your work Open your storefront URL in a web browser to check whether the upgrade was successful. If your upgrade was unsuccessful, your storefront will not load properly. diff --git a/guides/v2.3/install-gde/composer.md b/guides/v2.3/install-gde/composer.md index f43c61391b0..704b5d3c0ea 100644 --- a/guides/v2.3/install-gde/composer.md +++ b/guides/v2.3/install-gde/composer.md @@ -52,31 +52,7 @@ To get the Magento metapackage: {:.bs-callout-info} {{site.data.var.ee}} customers can access 2.3.x patches two weeks before the General Availability (GA) date. -### Example - Minor release - -Minor releases contain new features, quality fixes, and security fixes. Use Composer to download a specific minor release. For example, to download the {{site.data.var.ee}} 2.3.0 metapackage: - -```bash -composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0 -``` - -### Example - Quality patch - -Quality patches primarily contain functional _and_ security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to download the {{site.data.var.ee}} 2.3.3 metapackage: - -```bash -composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.3 -``` - -### Example - Security patch - -Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. - -Security patches use the Composer naming convention `2.3.2-px`. Use Composer to download a security patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: - -```bash -composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.2-p1 -``` +{% include install/composer-examples.md %} ## Set file permissions From 6b2ce300ac1c344cfccbcc0b8b44b86658543327 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 15 Aug 2019 15:27:37 -0500 Subject: [PATCH 04/11] MAGEDOC-4202: Add include file --- _includes/install/composer-examples.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 _includes/install/composer-examples.md diff --git a/_includes/install/composer-examples.md b/_includes/install/composer-examples.md new file mode 100644 index 00000000000..a519a0ec12c --- /dev/null +++ b/_includes/install/composer-examples.md @@ -0,0 +1,25 @@ +### Example - Minor release + +Minor releases contain new features, quality fixes, and security fixes. Use Composer to specify a minor release. For example, to specify the {{site.data.var.ee}} 2.3.0 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0 +``` + +### Example - Quality patch + +Quality patches primarily contain functional _and_ security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to specify the {{site.data.var.ee}} 2.3.3 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.3 +``` + +### Example - Security patch + +Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. + +Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.2-p1 +``` \ No newline at end of file From 44118edfaa553a004357d8b7f837b4a0c8ba5110 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 15 Aug 2019 15:31:42 -0500 Subject: [PATCH 05/11] MAGEDOC-4042: Change location of optional lable --- guides/v2.3/comp-mgr/cli/cli-upgrade.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index d0d6fa32925..96c8a2e7412 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -207,9 +207,9 @@ Manually clear caches and generated content. bin/magento maintenance:disable ``` -1. Restart Varnish. +1. _(Optional)_ Restart Varnish. - _Optional_—If you use Varnish for page caching, restart it: + If you use Varnish for page caching, restart it: ```bash service varnish restart From 2606a3c1f0e7464337f51212096e5ebdffc75307 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 15 Aug 2019 17:19:33 -0500 Subject: [PATCH 06/11] Fixed anchor link --- guides/v2.3/comp-mgr/cli/cli-upgrade.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index 96c8a2e7412..ee78f649631 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -102,7 +102,8 @@ See the examples at the end of this section for help specifying different releas composer remove --dev sjparkinson/static-review fabpot/php-cs-fixer --no-update ``` -1. Update `autoload`. +1. Update the `autoload` property. +{: #update-autoload } Open `composer.json` and edit the `"autoload": "psr-4"` section to include `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"`: From cd02d5578ccc206469346b0877e122c8e19d90ee Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Thu, 15 Aug 2019 17:46:07 -0500 Subject: [PATCH 07/11] MAGEDOC-4042: Fixed indentation for autoload example --- guides/v2.3/comp-mgr/cli/cli-upgrade.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index ee78f649631..6f27d7767b7 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -102,10 +102,8 @@ See the examples at the end of this section for help specifying different releas composer remove --dev sjparkinson/static-review fabpot/php-cs-fixer --no-update ``` -1. Update the `autoload` property. {: #update-autoload } - - Open `composer.json` and edit the `"autoload": "psr-4"` section to include `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"`: +1. Open the `composer.json` file and edit the `"autoload"` property to include `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"`. ```json "autoload": { From 49286a68903d72da156361f61bd9548619d5263c Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 16 Aug 2019 07:51:57 -0500 Subject: [PATCH 08/11] MAGEDOC-4042: Move anchor to fix numbered list --- guides/v2.3/comp-mgr/cli/cli-upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index 6f27d7767b7..02d09437542 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -102,8 +102,8 @@ See the examples at the end of this section for help specifying different releas composer remove --dev sjparkinson/static-review fabpot/php-cs-fixer --no-update ``` -{: #update-autoload } 1. Open the `composer.json` file and edit the `"autoload"` property to include `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"`. + {: #update-autoload } ```json "autoload": { From 60a9cb5140a721f8677339496c60fdf27a94bf45 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 16 Aug 2019 09:25:24 -0500 Subject: [PATCH 09/11] MAGEDOC-4042: Peer review edits --- guides/v2.3/cloud/project/project-upgrade.md | 2 -- guides/v2.3/comp-mgr/cli/cli-upgrade.md | 37 ++++++-------------- 2 files changed, 11 insertions(+), 28 deletions(-) diff --git a/guides/v2.3/cloud/project/project-upgrade.md b/guides/v2.3/cloud/project/project-upgrade.md index 90e38dfcafa..5fb18391afc 100644 --- a/guides/v2.3/cloud/project/project-upgrade.md +++ b/guides/v2.3/cloud/project/project-upgrade.md @@ -20,8 +20,6 @@ You can upgrade the core {{site.data.var.ee}} code base to version 2.3. It is be If you use PHP version 7.2, you must remove the `mcrypt` extension from the [`extensions` section of the `.magento.app.yaml` file]({{page.baseurl}}/cloud/project/project-conf-files_magento-app.html#configure-php-options). For Pro projects, you need to create a support ticket to completely disable the `mcrypt` extension. -1. Before completing the upgrade, you must [update the `autoload`]({{page.baseurl}}/comp-mgr/cli/cli-upgrade.html#update-autoload) property of the `composer.json` file. - 1. Change to your Magento root directory and set the upgrade version using the [version constraint syntax]({{page.baseurl}}/cloud/project/ece-tools-upgrade-project.html#metapackage). ```bash diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index 02d09437542..6abad663e1b 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -49,9 +49,7 @@ See the examples at the end of this section for help specifying different releas cp composer.json composer.json.bak ``` -1. Add or remove specific packages based on your needs. - -1. Deactivate the {{ ce }} update (for edition upgrade only). _Optional_—If you are upgrading from {{ ce }} to {{ ee }}, deactivate the {{ ce }} update: +1. Add or remove specific packages based on your needs. For example, if you are upgrading from {{ ce }} to {{ ee }}, remove the {{ ce }} package. ```bash composer remove magento/product-community-edition --no-update @@ -61,7 +59,7 @@ See the examples at the end of this section for help specifying different releas _{{ ce }}_: - `` `bash + ```bash composer require magento/product-community-edition={{ page.guide_version }}.3 --no-update ``` @@ -72,15 +70,15 @@ See the examples at the end of this section for help specifying different releas ```
- To see the full list of available {{ page.guide_version }} version: + To see the full list of available {{ page.guide_version }} versions: - _Magento Open Source_: + _{{site.data.var.ce}}_: ```bash composer show magento/product-community-edition {{ page.guide_version }}.* --all | grep -m 1 versions ``` - _Magento Commerce_: + _{{site.data.var.ce}}_: ```bash composer show magento/product-enterprise-edition {{ page.guide_version }}.* --all | grep -m 1 versions @@ -102,29 +100,15 @@ See the examples at the end of this section for help specifying different releas composer remove --dev sjparkinson/static-review fabpot/php-cs-fixer --no-update ``` -1. Open the `composer.json` file and edit the `"autoload"` property to include `"Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/"`. - {: #update-autoload } - - ```json - "autoload": { - "psr-4": { - "Magento\\Framework\\": "lib/internal/Magento/Framework/", - "Magento\\Setup\\": "setup/src/Magento/Setup/", - "Magento\\": "app/code/Magento/", - "Zend\\Mvc\\Controller\\": "setup/src/Zend/Mvc/Controller/" - }, - //... - } - ``` - {% include install/composer-examples.md %} -## (_Optional)_ Modify the Magento updater +## (_Optional)_ Recreate the Magento updater -If the Magento updater is installed, modify it (it is located in the `update/` directory): +If the Magento updater is installed, remove and recreate it. It is located in the `update/` directory. 1. Backup the `update/` directory. -2. Create a Composer project. + +1. Create a Composer project. _{{ ce }} version {{ page.guide_version }}.3:_ @@ -140,7 +124,8 @@ If the Magento updater is installed, modify it (it is located in the `update/` d {: .bs-callout-info } If you need to use a repository that contains non-public packages, such as internal sandboxes, change the URL in `--repository` accordingly. -3. Remove the old `update/` directory and move `temp_dir/update/` to the `update/` directory: + +1. Remove the old `update/` directory and move `temp_dir/update/` to the `update/` directory: ```bash rm -rf update From 75e88773cf5d99efd8b2ae67d395c55c0ce4a518 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 16 Aug 2019 10:26:15 -0500 Subject: [PATCH 10/11] MAGEDOC-4042: Removed include file b/c upgrade requires diff comamnd than new download --- _includes/install/composer-examples.md | 25 ------------------------ guides/v2.3/comp-mgr/cli/cli-upgrade.md | 26 ++++++++++++++++++++++++- guides/v2.3/install-gde/composer.md | 26 ++++++++++++++++++++++++- 3 files changed, 50 insertions(+), 27 deletions(-) delete mode 100644 _includes/install/composer-examples.md diff --git a/_includes/install/composer-examples.md b/_includes/install/composer-examples.md deleted file mode 100644 index a519a0ec12c..00000000000 --- a/_includes/install/composer-examples.md +++ /dev/null @@ -1,25 +0,0 @@ -### Example - Minor release - -Minor releases contain new features, quality fixes, and security fixes. Use Composer to specify a minor release. For example, to specify the {{site.data.var.ee}} 2.3.0 metapackage: - -```bash -composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0 -``` - -### Example - Quality patch - -Quality patches primarily contain functional _and_ security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to specify the {{site.data.var.ee}} 2.3.3 metapackage: - -```bash -composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.3 -``` - -### Example - Security patch - -Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. - -Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: - -```bash -composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.2-p1 -``` \ No newline at end of file diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index 6abad663e1b..79ddd8671d7 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -100,7 +100,31 @@ See the examples at the end of this section for help specifying different releas composer remove --dev sjparkinson/static-review fabpot/php-cs-fixer --no-update ``` -{% include install/composer-examples.md %} +### Example - Minor release + +Minor releases contain new features, quality fixes, and security fixes. Use Composer to specify a minor release. For example, to specify the {{site.data.var.ee}} 2.3.0 metapackage: + +```bash +composer require magento/product-community-edition=2.3.0 --no-update +``` + +### Example - Quality patch + +Quality patches primarily contain functional _and_ security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to specify the {{site.data.var.ee}} 2.3.3 metapackage: + +```bash +composer require magento/product-community-edition=2.3.3 --no-update +``` + +### Example - Security patch + +Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. + +Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: + +```bash +composer require magento/product-community-edition=2.3.2-p1 --no-update +``` ## (_Optional)_ Recreate the Magento updater diff --git a/guides/v2.3/install-gde/composer.md b/guides/v2.3/install-gde/composer.md index 704b5d3c0ea..0501b726630 100644 --- a/guides/v2.3/install-gde/composer.md +++ b/guides/v2.3/install-gde/composer.md @@ -52,7 +52,31 @@ To get the Magento metapackage: {:.bs-callout-info} {{site.data.var.ee}} customers can access 2.3.x patches two weeks before the General Availability (GA) date. -{% include install/composer-examples.md %} +### Example - Minor release + +Minor releases contain new features, quality fixes, and security fixes. Use Composer to specify a minor release. For example, to specify the {{site.data.var.ee}} 2.3.0 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0 +``` + +### Example - Quality patch + +Quality patches primarily contain functional _and_ security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to specify the {{site.data.var.ee}} 2.3.3 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.3 +``` + +### Example - Security patch + +Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. + +Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: + +```bash +composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.2-p1 +``` ## Set file permissions From aa69367a9c51be8778be1772f9bbc26a27bc610b Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 23 Aug 2019 09:18:41 -0500 Subject: [PATCH 11/11] MAGEDOC-4042: Changed 2.3.2.1 to 2.3.2-p1 --- guides/v2.3/comp-mgr/cli/cli-upgrade.md | 2 +- guides/v2.3/install-gde/composer.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/guides/v2.3/comp-mgr/cli/cli-upgrade.md b/guides/v2.3/comp-mgr/cli/cli-upgrade.md index 79ddd8671d7..add0aa68685 100644 --- a/guides/v2.3/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.3/comp-mgr/cli/cli-upgrade.md @@ -120,7 +120,7 @@ composer require magento/product-community-edition=2.3.3 --no-update Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. -Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: +Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2-p1 metapackage: ```bash composer require magento/product-community-edition=2.3.2-p1 --no-update diff --git a/guides/v2.3/install-gde/composer.md b/guides/v2.3/install-gde/composer.md index ad3ef91bd3b..755ca4b9dce 100644 --- a/guides/v2.3/install-gde/composer.md +++ b/guides/v2.3/install-gde/composer.md @@ -74,7 +74,7 @@ composer create-project --repository-url=https://repo.magento.com/ magento/proje Security patches contain security fixes only. They are designed to make the upgrade process faster and easier. -Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2.1 metapackage: +Security patches use the Composer naming convention `2.3.2-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ee}} 2.3.2-p1 metapackage: ```bash composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.2-p1