Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 148f54f

Browse files
Merge pull request magento-commerce/devdocs#2457 from magento-devdocs/ds_DOC-351
Add Community MQP release notes
2 parents b060608 + d9654ae commit 148f54f

File tree

9 files changed

+59
-41
lines changed

9 files changed

+59
-41
lines changed

src/_data/toc/software-update-guide.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,16 @@ pages:
7373
url: /comp-mgr/patching.html
7474
children:
7575

76-
- label: Commerce Quality Patches
76+
- label: Quality Patches Tool
7777
url: /comp-mgr/patching/mqp.html
7878
children:
7979

80-
- label: MQP release notes
81-
url: /quality-patches/release-notes.html
80+
- label: Quality patches for Adobe Commerce
81+
url: /quality-patches/release-notes-commerce.html
82+
versionless: true
83+
84+
- label: Quality patches for Magento Open Source
85+
url: /quality-patches/release-notes-open-source.html
8286
versionless: true
8387

8488
- label: Command Line

src/_data/whats-new.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2518,7 +2518,7 @@ entries:
25182518
link: https://github.com/magento/devdocs/pull/7785
25192519
contributor: dshevtsov
25202520
profile: https://github.com/dshevtsov
2521-
- description: Added information about the Magento Quality Patches package in the
2521+
- description: Added information about the Quality Patches tool in the
25222522
[Software Upgrade Guide](https://devdocs.magento.com/guides/v2.4/comp-mgr/patching.html)
25232523
and [Cloud Guide](https://devdocs.magento.com/cloud/project/project-patch.html).
25242524
versions: 2.3.x, 2.4.x
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
The [Quality Patches Tool](https://github.com/magento/quality-patches) delivers individual patches developed by Adobe and the {{ site.data.var.ce }} community. It allows you to apply, revert, and view general information about all individual patches that are available for the installed version of {{ site.data.var.ee }} or {{ site.data.var.ce }}. You can apply patches to {{site.data.var.ee}} and {{site.data.var.ce}} projects regardless of who developed the patch. For example, you can apply a patch developed by the community to {{site.data.var.ee}} projects.
2+
3+
{:.bs-callout-info}
4+
See [Apply patches]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) for instructions on applying patches to your {{ site.data.var.ee }} or {{ site.data.var.ce }} projects.
5+
See [Patches available in the Quality Patches Tool](https://support.magento.com/hc/en-us/sections/360010506631-Patches-available-in-MQP-tool-) for additional patch details.

src/cloud/project/project-patch.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ functional_areas:
66
- Upgrade
77
---
88

9-
[{{ site.data.var.mcp-prod }}](https://github.com/magento/magento-cloud-patches) and [Magento Quality Patches](https://github.com/magento/quality-patches) deliver patches to your installed Magento application.
9+
[{{ site.data.var.mcp-prod }}](https://github.com/magento/magento-cloud-patches) and the [Quality Patches Tool](https://github.com/magento/quality-patches) deliver patches to your installed Adobe Commerce application.
1010

1111
- {{ site.data.var.mcp-prod }} delivers required patches with critical fixes
12-
- Magento Quality Patches delivers optional, low-impact quality fixes as [individual patches]({{ site.baseurl }}/release/policy/#individual-patch), which do not contain backward incompatible changes.
12+
- Quality Patches deliver optional, low-impact quality fixes as [individual patches]({{ site.baseurl }}/release/policy/#individual-patch), which do not contain backward incompatible changes.
1313

1414
Both packages improve the integration of all {{site.data.var.ee}} versions with Cloud environments and support quick delivery of critical, optional, and custom fixes. You can use these packages to apply, revert, and view general information about all individual patches that are available for Magento.
1515

1616
{:.bs-callout-tip}
17-
You can use the [Magento Quality Patches]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) and [{{ site.data.var.mcp-prod }}](#standalone) packages as stand-alone packages for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects. We recommend using the Magento Quality Patches package for non-Cloud projects.
17+
You can use the [Quality Patches Tool]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) and [{{ site.data.var.mcp-prod }}](#standalone) packages as stand-alone packages for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects. We recommend using the Quality Patches Tool for non-Cloud projects.
1818

1919
When you deploy changes to the remote environment, `{{site.data.var.ct}}` uses {{ site.data.var.mcp-package }} and `magento/quality-patches` to check for pending patches and applies them automatically in the following order:
2020

2121
1. Apply all required Magento patches included in the {{ site.data.var.mcp-prod }} package.
22-
1. Apply selected optional Magento patches included in the Magento Quality Patches package.
22+
1. Apply selected optional Magento patches included in the Quality Patches Tool.
2323
1. Apply custom patches in the `/m2-hotfixes` directory in alphabetical order by patch name.
2424

2525
{:.bs-callout-info}
@@ -29,7 +29,7 @@ When you update `{{ site.data.var.ct }}` or the {{ site.data.var.mcp-prod }} pac
2929

3030
{% include cloud/note-upgrade.md %}
3131

32-
The Magento Quality Patches package is a dependency for the {{ site.data.var.mcp-prod }} and {{site.data.var.ct}} packages. To apply the latest patches, you must have [the latest version of {{ site.data.var.ct }}]({{site.baseurl}}/cloud/project/ece-tools-update.html) installed. The minimum required version of {{site.data.var.ct}} is 2002.1.2.
32+
The Quality Patches Tool is a dependency for the {{ site.data.var.mcp-prod }} and {{site.data.var.ct}} packages. To apply the latest patches, you must have [the latest version of {{ site.data.var.ct }}]({{site.baseurl}}/cloud/project/ece-tools-update.html) installed. The minimum required version of {{site.data.var.ct}} is 2002.1.2.
3333

3434
## View available patches and status
3535

@@ -82,7 +82,7 @@ Magento 2 Enterprise Edition, version 2.3.5.0
8282
The status table contains the following types of information:
8383

8484
- **Type**:
85-
- `Optional`—All patches from the MQP package and the [Magento Cloud Patches]({{ site.baseurl }}/cloud/project/project-patch.html) package are optional for {{ site.data.var.ee }} and {{ site.data.var.ce }} installations. For {{ site.data.var.ece }}, all MQP patches are optional.
85+
- `Optional`—All patches from the Quality Patches Tool and the [Magento Cloud Patches]({{ site.baseurl }}/cloud/project/project-patch.html) package are optional for {{ site.data.var.ee }} and {{ site.data.var.ce }} installations. For {{ site.data.var.ece }}, all MQP patches are optional.
8686
- `Required`—All patches from the {{ site.data.var.mcp-prod }} package are required for Cloud customers.
8787
- `Deprecated`—The individual patch is marked as deprecated and we recommend reverting it if you have applied it. After you revert a deprecated patch, it will no longer be displayed in the status table.
8888
- `Custom`—All patches from the 'm2-hotfixes' directory.
@@ -201,7 +201,7 @@ To apply and test a custom patch on a Cloud environment:
201201

202202
## Apply patches to a non-Cloud project {#standalone}
203203

204-
Use the [Magento Quality Patches]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) package for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects.
204+
Use the [Quality Patches Tool]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects.
205205

206206
## Revert a patch in a local environment
207207

@@ -221,4 +221,4 @@ This command reverts all patches in the following order:
221221

222222
## Logging
223223

224-
The Magento Quality Patches package logs all operations to the `<Project_root>/var/log/patch.log` file.
224+
The Quality Patches Tool logs all operations to the `<Project_root>/var/log/patch.log` file.

src/cloud/release-notes/ece-release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ See [Upgrades and patches]({{ site.baseurl }}/cloud/project/project-upgrade-pare
7676

7777
- {:.new}Added support for Elasticsearch 7.9 and Redis 6 for compatibility with upcoming {{site.data.var.ee}} releases.<!--MCLOUD-7191-->
7878

79-
- {:.fix}Updated the ece-tools `composer.json` to add a required dependency for the Quality Patches Tool package. This fixes a circular dependency that existed between the ece-tools and magento-cloud-patches packages.<!--MCLOUD-6910-->
79+
- {:.fix}Updated the ece-tools `composer.json` to add a required dependency for the Quality Patches Tool. This fixes a circular dependency that existed between the ece-tools and magento-cloud-patches packages.<!--MCLOUD-6910-->
8080

8181
**Validation and log improvements**
8282

src/guides/v2.3/comp-mgr/patching.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Hot fixes can contain backward incompatible changes.
3737

3838
Individual patches contain low-impact quality fixes for a specific issue. These fixes are applied to the most recently supported minor version of Magento (for example, 2.4.x), but could be missing from the previous supported minor version of Magento (for example, 2.3.x). Magento releases individual patches as needed.
3939

40-
Use the [Magento Quality Patches (MQP) package][MQP] to apply individual patches.
40+
Use the [Quality Patches Tool][] to apply individual patches.
4141

4242
{:.bs-callout-info}
4343
Individual patches do not contain backward incompatible changes.
@@ -81,7 +81,7 @@ index c8a6fef58d31..7d01c195791e 100644
8181

8282
You can apply patches using any of the following methods:
8383

84-
- [Magento Quality Patch (MQP) package][MQP]
84+
- [Quality Patches Tool][]
8585
- [Command line][]
8686
- [Composer][]
8787

@@ -103,4 +103,4 @@ To apply a patch to a {{site.data.var.ece}} project, see [Apply patches][].
103103
[Apply patches]:{{ site.baseurl }}/cloud/project/project-patch.html
104104
[Command line]:{{ page.baseurl }}/comp-mgr/patching/command-line.html
105105
[Composer]:{{ page.baseurl }}/comp-mgr/patching/composer.html
106-
[MQP]: {{ page.baseurl }}/comp-mgr/patching/mqp.html
106+
[Quality Patches Tool]: {{ page.baseurl }}/comp-mgr/patching/mqp.html

src/guides/v2.3/comp-mgr/patching/mqp.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
group: software-update-guide
3-
title: Commerce Quality Patches
3+
title: Quality Patches Tool
44
functional_areas:
55
- Upgrade
66
---
77

8-
The [Magento Quality Package package][] delivers individual patches developed by Magento and allows you to apply, revert, and view general information about all individual patches that are available for the installed version of {{ site.data.var.ee }} or {{ site.data.var.ce }}. See the [Apply Patches]({{ site.baseurl }}/cloud/project/project-patch.html) topic in the _Cloud Guide_ for details on installing and using MQP for {{ site.data.var.ece }}.
8+
{% include install/patch/quality-patch-intro.md %}
99

1010
{:.bs-callout-warning}
11-
We do not recommend using the MQP package to apply large numbers of patches because it increases the complexity of your code, which makes upgrading to a new version of Magento more difficult.
11+
We do not recommend using the Quality Patches Tool to apply large numbers of patches because it increases the complexity of your code, which makes upgrading to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }} more difficult.
1212

13-
#### Install the MQP package
13+
#### Install
1414

1515
{:.bs-callout-info}
16-
If it is not already installed, you must install [Git](https://github.com/git-guides/install-git) or [Patch](https://man7.org/linux/man-pages/man1/patch.1.html) before installing the MQP package.
16+
If it is not already installed, you must install [Git](https://github.com/git-guides/install-git) or [Patch](https://man7.org/linux/man-pages/man1/patch.1.html) before installing the Quality Patches Tool.
1717
Add the `magento/quality-patches` Composer package to your `composer.json` file:
1818

1919
```bash
@@ -22,7 +22,7 @@ composer require magento/quality-patches
2222

2323
#### View individual patches
2424

25-
To view the list of individual patches available for your version of Magento:
25+
To view the list of individual patches available for your version of {{ site.data.var.ee }} or {{ site.data.var.ce }}:
2626

2727
```bash
2828
./vendor/bin/magento-patches status
@@ -70,21 +70,21 @@ Magento 2 Enterprise Edition, version 2.3.5.0
7070
The status table contains the following types of information:
7171

7272
- **Type**:
73-
- `Optional`—All patches from the MQP package and the [Magento Cloud Patches]({{ site.baseurl }}/cloud/project/project-patch.html) package are optional for {{ site.data.var.ee }} and {{ site.data.var.ce }} installations.
74-
- `Deprecated`Magento has deprecated the individual patch. If you have applied the patch, we recommend that you revert it. The revert operation also removes the patch from the status table.
73+
- `Optional`—All patches from the Quality Patches Tool and the [Magento Cloud Patches]({{ site.baseurl }}/cloud/project/project-patch.html) package are optional for {{ site.data.var.ee }} and {{ site.data.var.ce }} installations.
74+
- `Deprecated`Adobe has deprecated the individual patch. If you have applied the patch, we recommend that you revert it. The revert operation also removes the patch from the status table.
7575

7676
- **Status**:
7777
- `Applied`—The patch has been applied.
7878
- `Not applied`—The patch has not been applied.
7979
- `N/A`—The status of the patch cannot be defined due to conflicts.
8080

8181
- **Details**:
82-
- `Affected components`—The list of affected Magento modules.
82+
- `Affected components`—The list of affected modules.
8383
- `Required patches`—The list of patches that must be applied for an indicated patch to work properly (dependencies).
8484
- `Recommended replacement`—The patch that is a recommended replacement for a deprecated patch.
8585

8686
{:.bs-callout-info}
87-
After upgrading to a new version of Magento, you must re-apply patches if the patches are not included in the new version. See [Re-apply patches after an upgrade](#upgrade).
87+
After upgrading to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }}, you must re-apply patches if the patches are not included in the new version. See [Re-apply patches after an upgrade](#upgrade).
8888

8989
#### Apply individual patches
9090

@@ -110,7 +110,7 @@ You must clean the cache after applying patches to see changes in the Magento ap
110110
```
111111

112112
{:.bs-callout-info}
113-
Consider keeping a list of applied patches in a separate location. You might need to re-apply some of them after upgrading to a new version of Magento. See [Re-apply patches after an upgrade](#upgrade).
113+
Consider keeping a list of applied patches in a separate location. You might need to re-apply some of them after upgrading to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }}. See [Re-apply patches after an upgrade](#upgrade).
114114

115115
#### Revert individual patches
116116

@@ -143,7 +143,7 @@ You must clean the cache after reverting patches to see changes in the Magento a
143143

144144
#### Get updates
145145

146-
Magento periodically releases new individual patches. You must update the MQP package to get new individual patches:
146+
Magento periodically releases new individual patches. You must update the Quality Patches Tool to get new individual patches:
147147

148148
```bash
149149
composer update magento/quality-patches
@@ -160,12 +160,12 @@ New add patches display at the bottom of the table.
160160

161161
#### Re-apply patches after an upgrade {#upgrade}
162162

163-
When you upgrade to a new version of Magento, you must re-apply patches if the patches are not included in the new version.
163+
When you upgrade to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }}, you must re-apply patches if the patches are not included in the new version.
164164

165165
{:procedure}
166166
To re-apply patches:
167167

168-
1. Update the MQP package:
168+
1. Update the Quality Patches Tool:
169169

170170
```bash
171171
composer update magento/quality-patches.
@@ -192,8 +192,4 @@ To re-apply patches:
192192

193193
#### Logging
194194

195-
The MQP package logs all operations in the `<Magento_root>/var/log/patch.log` file.
196-
197-
<!-- Link Definitions -->
198-
199-
[Magento Quality Package package]: https://github.com/magento/quality-patches
195+
The Quality Patches Tool logs all operations in the `<Magento_root>/var/log/patch.log` file.

src/quality-patches/release-notes.md renamed to src/quality-patches/release-notes-commerce.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
---
22
group: software-update-guide
3-
title: Magento Quality Patches release notes
3+
title: Quality patches for Adobe Commerce
44
functional_areas:
55
- Setup
66
- Configuration
77
- Upgrade
8+
redirect_from: /quality-patches/release-notes.html
89
---
910

10-
The [Magento Quality Patches](https://github.com/magento/quality-patches) package delivers individual patches developed by Magento and allows you to apply, revert, and view general information about all individual patches that are available for the installed version of {{ site.data.var.ee }} or {{ site.data.var.ce }}.
11+
{% include install/patch/quality-patch-intro.md %}
12+
13+
For information about quality patches created by the community for {{site.data.var.ce}}, see the [release notes](https://github.com/magento/quality-patches/blob/master/community-release-notes.md).
1114

1215
<!-- The release notes include:
1316
1417
- {:.new}New features
1518
- {:.fix}Fixes and improvements
1619
- {:.bug}Known issues -->
1720

18-
{:.bs-callout-info}
19-
See [Apply patches]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) for instructions on applying patches to your Magento projects.
20-
See [Patches available in MQP tool](https://support.magento.com/hc/en-us/sections/360010506631-Patches-available-in-MQP-tool-) for additional patch details.
21-
2221
## v1.1.1
2322

2423
- **MDVA-36021** _(for Adobe Commerce and Magento Open Source `>=2.4.0 <2.4.4`)_-Fixes the issue where the 'Call to a member function getId()' error is displayed on the order details page in the Admin.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
group: software-update-guide
3+
title: Quality patches for Magento Open Source
4+
functional_areas:
5+
- Setup
6+
- Configuration
7+
- Upgrade
8+
---
9+
10+
{% include install/patch/quality-patch-intro.md %}
11+
12+
For information about quality patches created by the community for {{site.data.var.ce}}, see the [release notes](https://github.com/magento/quality-patches/blob/master/community-release-notes.md).
13+
14+
For information about quality patches created by Adobe for {{site.data.var.ee}}, see the [release notes]({{ site.baseurl }}/quality-patches/release-notes-commerce.html).

0 commit comments

Comments
 (0)