Skip to content

Commit 38af95a

Browse files
committed
Merge branch 'main' of github.com:strapi/documentation
2 parents d7e485e + a1749f8 commit 38af95a

File tree

6 files changed

+53
-27
lines changed

6 files changed

+53
-27
lines changed

docusaurus/docs/cloud/projects/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Updating the git repository could result in the loss of the project and its data
7474
| Auto-deploy | Tick the box to automatically trigger a new deployment whenever a new commit is pushed to the selected branch. Untick it to disable the option. |
7575

7676
5. Click on the **Update repository** button at the bottom of the *Update repository* interface.
77-
6. In the *Manage repository* dialog, confirm your changes by clicking on the **Relink repository** button.
77+
6. In the *Update repository* dialog, confirm your changes by clicking on the **Confirm** button.
7878

7979
#### Deleting Strapi Cloud project
8080

docusaurus/docs/dev-docs/upgrade-tool.md

Lines changed: 52 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,25 @@ Strapi version numbers respect the [semantic versioning](https://semver.org/) co
5555
- The second number is the **minor** version number.
5656
- The third number is the **patch** version number.
5757

58-
The upgrade tool allows upgrading to a major, minor, or patch version.
58+
The upgrade tool allows upgrading to a `major`, `minor`, or `patch` version.
5959

60-
What the upgrade tool does depends on the latest existing version and the command you run.
60+
Alternatively, you can choose to upgrade to the `latest` available version.
6161

62-
For instance, if the latest Strapi v4 version is v4.25.9:
62+
What the upgrade tool does depends on three things:
6363

64-
| My Strapi application is currently on… | If I run… | My Strapi application will be upgraded to … |
65-
|----------------------------------------|-----------------------------|--------------------------------------------------------------------------------------------|
66-
| v4.25.1 | `npx @strapi/upgrade patch` | v4.25.9<br/><br/>(because v4.25.9 is the latest patch version for the v4.25 minor version) |
67-
| v4.14.1 | `npx @strapi/upgrade minor` | v4.25.9 |
68-
| v4.14.1 | `npx @strapi/upgrade major` | Nothing.<br/><br/>I first need to run `npx @strapi/upgrade minor` to upgrade to v4.25.9. |
69-
| v4.25.9 | `npx @strapi/upgrade major` | v5.0.0 |
64+
- the project Strapi version
65+
- the latest available version of Strapi
66+
- the command you run.
7067

68+
For instance, if the latest Strapi v4 version is v4.25.9, and the latest Strapi v5 version is v5.1.2:
7169

70+
| My Strapi application is currently on… | If I run… | My Strapi application will be upgraded to … |
71+
|----------------------------------------|------------------------------|-------------------------------------------------------------------------------------------------|
72+
| v4.25.1 | `npx @strapi/upgrade patch` | v4.25.9<br/><br/>(because v4.25.9 is the latest patch version for the v4.25 minor version) |
73+
| v4.14.1 | `npx @strapi/upgrade minor` | v4.25.9 |
74+
| v4.14.1 | `npx @strapi/upgrade major` | Nothing.<br/><br/>I first need to run `npx @strapi/upgrade minor` to upgrade to v4.25.9. |
75+
| v4.25.9 | `npx @strapi/upgrade major` | v5.1.2 |
76+
| v4.14.1 | `npx @strapi/upgrade latest` | v5.1.2 <br/><br/>A confirmation prompt appears to make sure the major version bump is intended. |
7277

7378
## Upgrade to a new version
7479

@@ -78,21 +83,23 @@ Before running the upgrade process, make sure you've created a backup of your co
7883

7984
### Upgrade to a major version
8085

81-
Run the upgrade tool with the `major` parameter to upgrade the project to the next major version of Strapi:
86+
Run the upgrade tool with the `major` parameter to upgrade the project to the latest release of the next major Strapi version:
8287

8388
```bash
8489
npx @strapi/upgrade major
8590
```
8691

87-
During the upgrade process, the application dependencies are updated and installed, and the related codemods are executed.
92+
During the upgrade process, the application dependencies are updated and installed, and the related codemods are executed (if any).
8893

8994
:::note
90-
If your application is not already running the latest minor and patch version in the current major, the `major` upgrade is prevented, and you will first need to upgrade to the latest [minor.patch](#upgrade-to-a-minor-version) version in the current major version. This means that moving from v4.14.4 to v5.0.0 is a 2-step process because the latest v4 version is v4.16.2.
95+
If your application is not already running the latest minor and patch version in the current major, the `major` upgrade is prevented, and you will first need to upgrade to the latest [minor.patch](#upgrade-to-a-minor-version) version in the current major version.
96+
97+
This means that moving from v4.14.4 to v5.0.0 is a 2-step process because the latest v4 version is v4.16.2.
9198
:::
9299

93100
### Upgrade to a minor version
94101

95-
Run the upgrade tool with the `minor` parameter to upgrade the project to the latest minor and patch version of Strapi:
102+
Run the upgrade tool with the `minor` parameter to upgrade the project to the latest minor and patch version of Strapi for the current major:
96103

97104
```bash
98105
npx @strapi/upgrade minor
@@ -110,6 +117,23 @@ npx @strapi/upgrade patch
110117

111118
During the upgrade process, the project dependencies are updated and installed, and the related codemods are executed (if any).
112119

120+
### Upgrade to the latest version
121+
122+
Run the upgrade tool with the `latest` parameter to upgrade the project to the latest available version regardless of the current Strapi version:
123+
124+
```bash
125+
npx @strapi/upgrade latest
126+
```
127+
128+
During the upgrade process, the project dependencies are updated and installed, and the related codemods are executed (if any).
129+
130+
:::note
131+
If a `major` version upgrade is detected, the upgrade tool displays a confirmation prompt to make sure the change is
132+
intended.
133+
134+
In the scenario where the major bump isn't the desired option, see [the minor upgrade](#upgrade-to-a-minor-version).
135+
:::
136+
113137
## Run codemods only
114138

115139
Run the upgrade tool with the `codemods` parameter to execute a utility that allows selecting the codemods to be executed. With this command, only the codemods are run, the dependencies are not updated nor installed.
@@ -136,20 +160,20 @@ npx @strapi/upgrade codemods run 5.0.0-strapi-codemod-uid
136160

137161
The `npx @strapi/upgrade [major|minor|patch]` commands can accept the following options:
138162

139-
| Option | Description | Default |
140-
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------|----------|
141-
| [`-n, --dry`](#simulate-the-upgrade-without-updating-any-files-dry-run) | [Simulate](#simulate-the-upgrade-without-updating-any-files-dry-run) the upgrade without updating any files | false |
142-
| [`-d, --debug`](#get-detailed-debugging-information) | Get [more logs](#get-detailed-debugging-information) in debug mode | false |
143-
| [`-s, --silent`](#execute-the-upgrade-silently) | [Don't log anything](#execute-the-upgrade-silently) | false |
144-
| [`-p, --project-path <project-path>`](#select-a-path-for-the-strapi-application-folder) | [Path](#select-a-path-for-the-strapi-application-folder) to the Strapi project | - |
145-
| [`-y, --yes`](#answer-yes-to-every-prompt) | Automatically [answer "yes"](#answer-yes-to-every-prompt) to every prompt | false |
163+
| Option | Description | Default |
164+
|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------|
165+
| [`-n, --dry`](#simulate-the-upgrade-without-updating-any-files-dry-run) | [Simulate](#simulate-the-upgrade-without-updating-any-files-dry-run) the upgrade without updating any files | false |
166+
| [`-d, --debug`](#get-detailed-debugging-information) | Get [more logs](#get-detailed-debugging-information) in debug mode | false |
167+
| [`-s, --silent`](#execute-the-upgrade-silently) | [Don't log anything](#execute-the-upgrade-silently) | false |
168+
| [`-p, --project-path <project-path>`](#select-a-path-for-the-strapi-application-folder) | [Path](#select-a-path-for-the-strapi-application-folder) to the Strapi project | - |
169+
| [`-y, --yes`](#answer-yes-to-every-prompt) | Automatically [answer "yes"](#answer-yes-to-every-prompt) to every prompt | false |
146170

147-
The following options can be run either with the `npx @strapi/upgrade` command alone or with the `npx @strapi/upgrade [major|minor|patch]` commands:
171+
The following options can be run either with the `npx @strapi/upgrade` command alone or with the `npx @strapi/upgrade [major|minor|patch|latest]` commands:
148172

149-
| Option | Description |
150-
| ------------------------------------------------------------------------ | ---------------------------------------------------------------- |
151-
| [`-V, --version`](#get-the-current-version) | Output the [version number](#get-the-current-version) |
152-
| [`-h, --help`](#get-help) | [Print](#get-help) command line options |
173+
| Option | Description |
174+
|---------------------------------------------|-------------------------------------------------------|
175+
| [`-V, --version`](#get-the-current-version) | Output the [version number](#get-the-current-version) |
176+
| [`-h, --help`](#get-help) | [Print](#get-help) command line options |
153177

154178
### Simulate the upgrade without updating any files (dry run)
155179

@@ -161,6 +185,7 @@ Examples:
161185
npx @strapi/upgrade major --dry
162186
npx @strapi/upgrade minor --dry
163187
npx @strapi/upgrade patch --dry
188+
npx @strapi/upgrade latest --dry
164189
```
165190

166191
### Select a path for the Strapi application folder
@@ -226,9 +251,10 @@ Options:
226251
-h, --help Print command line options
227252
228253
Commands:
229-
major [options] Upgrade to the next available major version of Strapi
254+
major [options] Upgrade to ...
230255
minor [options] Upgrade to ...
231256
patch [options] Upgrade to ...
257+
latest [options] Upgrade to ...
232258
help [command] Print options for a specific command
233259
234260
```
-199 KB
Binary file not shown.
-187 KB
Binary file not shown.
-124 KB
Loading
-125 KB
Loading

0 commit comments

Comments
 (0)