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

Commit 843255e

Browse files
committed
Second round of dev comments
1 parent 20d5874 commit 843255e

File tree

2 files changed

+37
-26
lines changed

2 files changed

+37
-26
lines changed

src/guides/v2.3/comp-mgr/cli/cli-upgrade.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ Complete the following prerequisites to prepare your environment before starting
4747
This version of the plugin is not compatible with Composer 2.1.6 or higher
4848

4949
```bash
50-
composer require magento/composer-root-update-plugin=~1.0 --no-update
50+
composer require magento/composer-root-update-plugin ~1.1 --no-update
5151
```
5252

5353
To install the plugin when using PHP 7.3 or higher:
5454

5555
```bash
56-
composer require magento/composer-root-update-plugin=~2.0 --no-update
56+
composer require magento/composer-root-update-plugin ~2.0 --no-update
5757
```
5858

5959
Update the dependencies:
@@ -81,16 +81,17 @@ See the examples at the end of this section for help specifying different releas
8181

8282
1. Choose one of the following `composer` commands based on the PHP version, and run the command to upgrade your instance. For PHP 7.3 and later, use the `require-commerce` syntax.
8383

84-
For PHP 7.2 or lower:
84+
85+
For 7.3 or higher:
8586

8687
```bash
87-
composer require magento/<product>.<version> [--interactive-magento-conflicts] [--use-default-magento-values] --no-update [--help]
88+
composer require-commerce magento/<product> <version> --no-update [--interactive-root-conflicts] [--force-root-updates] [--help]
8889
```
8990

90-
For 7.3 or higher:
91+
For PHP 7.2 or lower:
9192

9293
```bash
93-
composer require-commerce magento/<product>.<version> [--interactive-magento-conflicts] [--use-default-magento-values] --no-update [--help]
94+
composer require magento/<product> <version> --no-update [--interactive-magento-conflicts] [--use-default-magento-values] [--help]
9495
```
9596

9697
where:
@@ -99,11 +100,11 @@ See the examples at the end of this section for help specifying different releas
99100

100101
`<version>` - (Required) The version of {{site.data.var.ce}} or {{site.data.var.ce}} you are upgrading to. For example, `2.3.7`.
101102

102-
`--interactive-magento-conflicts` - (Optional) Allows you to interactively view and update any out-of-date values that may be remaining from previous versions.
103+
`--no-update` - (Required) Disables the automatic update of the dependencies.
103104

104-
`--use-default-magento-values` - (Optional) Overrides all conflicting custom values with the expected Magento values.
105+
`--interactive-root-conflicts` or `interactive-magento-conflicts` - (Optional) Allows you to interactively view and update any out-of-date values that may be remaining from previous versions.
105106

106-
`--no-update` - (Required) Disables the automatic update of the dependencies.
107+
`--force-root-updates` or `--use-default-magento-values` - (Optional) Overrides all conflicting custom values with the expected Magento values.
107108

108109
`--help` - (Optional) Provides usage details about the plugin.
109110

@@ -112,20 +113,20 @@ See the examples at the end of this section for help specifying different releas
112113
To learn more about the plugin, refer to one of the following Plugin Usage README files:
113114

114115
- [PHP 7.3 or higher](https://github.com/magento/composer-root-update-plugin/blob/develop/src/Magento/ComposerRootUpdatePlugin/README.md)
115-
- [PHP 7.2 or lower](https://github.com/magento/composer-root-update-plugin/blob/0.1/src/Magento/ComposerRootUpdatePlugin/README.md)
116+
- [PHP 7.2 or lower](https://github.com/magento/composer-root-update-plugin/blob/1.1/src/Magento/ComposerRootUpdatePlugin/README.md)
116117

117118
**Examples:**
118119

119120
_{{ ce }}_:
120121

121122
```bash
122-
composer require-commerce magento/product-community-edition=2.3.7 --no-update
123+
composer require-commerce magento/product-community-edition 2.3.7 --no-update
123124
```
124125

125126
_{{ ee }}_:
126127

127128
```bash
128-
composer require-commerce magento/product-enterprise-edition=2.3.7 --no-update
129+
composer require-commerce magento/product-enterprise-edition 2.3.7 --no-update
129130
```
130131

131132
<div class="bs-callout-tip" markdown="1">
@@ -145,30 +146,36 @@ See the examples at the end of this section for help specifying different releas
145146

146147
</div>
147148

149+
1. Update the dependencies:
150+
151+
```bash
152+
composer update
153+
```
154+
148155
### Example - Minor release
149156

150157
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.7 metapackage:
151158

152159
```bash
153-
composer require magento/product-community-edition=2.3.7 --no-update
160+
composer require magento/product-community-edition 2.3.7 --no-update
154161
```
155162

156163
### Example - Quality patch
157164

158165
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.7 metapackage:
159166

160167
```bash
161-
composer require magento/product-community-edition=2.3.7 --no-update
168+
composer require magento/product-community-edition 2.3.7 --no-update
162169
```
163170

164171
### Example - Security patch
165172

166173
Security patches contain security fixes only. They are designed to make the upgrade process faster and easier.
167174

168-
Security patches use the Composer naming convention `2.3.6-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ce}} 2.3.6-p1 metapackage:
175+
Security patches use the Composer naming convention `2.3.x-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ce}} 2.3.6-p1 metapackage:
169176

170177
```bash
171-
composer require magento/product-community-edition=2.3.6-p1 --no-update
178+
composer require magento/product-community-edition 2.3.6-p1 --no-update
172179
```
173180

174181
## Update metadata

src/guides/v2.4/comp-mgr/cli/cli-upgrade.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Complete the following prerequisites to prepare your environment before starting
4949
To install the plugin:
5050

5151
```bash
52-
composer require magento/composer-root-update-plugin=~2.0 --no-update
52+
composer require magento/composer-root-update-plugin ~2.0 --no-update
5353
```
5454

5555
Update the dependencies:
@@ -78,7 +78,7 @@ See the examples at the end of this section for help specifying different releas
7878
1. Run the `composer require-commerce` command to upgrade your instance. The command has the following syntax:
7979

8080
```bash
81-
composer require-commerce magento/<product>.<version> [--interactive-root-conflicts] [--force-root-updates] --no update [--help]
81+
composer require-commerce magento/<product> <version> --no-update [--interactive-root-conflicts] [--force-root-updates] [--help]
8282
```
8383

8484
where:
@@ -87,12 +87,12 @@ See the examples at the end of this section for help specifying different releas
8787

8888
`<version>` - (Required) The version of {{site.data.var.ce}} or {{site.data.var.ce}} you are upgrading to. For example, `2.4.3`.
8989

90+
`--no-update` - (Required) Disables the automatic update of the dependencies.
91+
9092
`--interactive-root-conflicts` - (Optional) Allows you to interactively view and update any out-of-date values that may be remaining from previous versions, or any customized values that do not match the version you are upgrading to.
9193

9294
`--force-root-updates` - (Optional) Overrides all conflicting custom values with the expected Magento values.
9395

94-
`--no-update` - (Required) Disables the automatic update of the dependencies.
95-
9696
`--help` - (Optional) Provides usage details about the plugin.
9797

9898
If neither `--interactive-root-conflicts` nor `--force-root-updates` are specified, the command keeps the existing values that are in conflict and displays a warning message.
@@ -104,13 +104,13 @@ See the examples at the end of this section for help specifying different releas
104104
_{{ ce }}_:
105105

106106
```bash
107-
composer require-commerce magento/product-community-edition=2.4.3 --no-update
107+
composer require-commerce magento/product-community-edition 2.4.3 --no-update
108108
```
109109

110110
_{{ ee }}_:
111111

112112
```bash
113-
composer require-commerce magento/product-enterprise-edition=2.4.3 --no-update
113+
composer require-commerce magento/product-enterprise-edition 2.4.3 --no-update
114114
```
115115

116116
<div class="bs-callout-tip" markdown="1">
@@ -130,30 +130,34 @@ See the examples at the end of this section for help specifying different releas
130130

131131
</div>
132132

133+
1. Update the dependencies:
134+
135+
```bash
136+
composer update
133137
### Example - Minor release
134138
135139
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.4.3 metapackage:
136140
137141
```bash
138-
composer require-commerce magento/product-community-edition=2.4.3 --no-update
142+
composer require-commerce magento/product-community-edition 2.4.3 --no-update
139143
```
140144
141145
### Example - Quality patch
142146
143147
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.4.1 metapackage:
144148
145149
```bash
146-
composer require-commerce magento/product-community-edition=2.4.1 --no-update
150+
composer require-commerce magento/product-community-edition 2.4.1 --no-update
147151
```
148152
149153
### Example - Security patch
150154
151155
Security patches contain security fixes only. They are designed to make the upgrade process faster and easier.
152156
153-
Security patches use the Composer naming convention `2.4.3-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ce}} 2.4.3-p1 metapackage:
157+
Security patches use the Composer naming convention `2.4.x-px`. Use Composer to specify a patch. For example, to download the {{site.data.var.ce}} 2.4.3-p1 metapackage:
154158
155159
```bash
156-
composer require-commerce magento/product-community-edition=2.4.3-p1 --no-update
160+
composer require-commerce magento/product-community-edition 2.4.3-p1 --no-update
157161
```
158162
159163
## Update metadata

0 commit comments

Comments
 (0)