Skip to content

Commit c5512d6

Browse files
committed
Document major version upgrade support
1 parent 1a0dad5 commit c5512d6

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ The plugin automatically activates during `composer update` and:
3838

3939
In non-interactive environments (CI/CD), the plugin displays information but proceeds automatically. If the TYPO3 API is temporarily unavailable, the update continues without interruption.
4040

41+
## Major version upgrades
42+
43+
Cross-major updates (e.g. 12.4 → 13.4) are fully supported. Since a major upgrade path contains hundreds of breaking changes, the report switches to a condensed format:
44+
45+
- A banner announces the upgrade with links to the official upgrade guide and the changelog of every crossed major
46+
- Breaking changes appear as a per-release count (e.g. `13.0.0: ⚠️ 207 breaking changes`) instead of a full list — security updates keep their complete detail (CVEs, severities, bulletins)
47+
- Updates within a major line keep the detailed format as before
48+
- A major upgrade always asks for confirmation in interactive shells, even when release information could not be fetched
49+
- Jumping more than one major at once (e.g. 12 → 14) prints an additional warning, since TYPO3 officially supports upgrading one major version at a time
50+
4151
## Example output
4252

4353
![Demo](documentation/demo-89177017.gif)
@@ -55,8 +65,12 @@ Both arguments are optional. With no arguments it uses your installed `typo3/cms
5565
```bash
5666
composer typo3:check-updates # installed version → latest release
5767
composer typo3:check-updates 13.4.10 # 13.4.10 → latest release
68+
composer typo3:check-updates 12.4.10 13.4.5 # across major versions
5869
```
5970

71+
> [!NOTE]
72+
> Defaults always stay within the installed major line — a cross-major check happens only when you pass the target explicitly. For an unknown cross-major target, the command offers the latest release of the requested major's line.
73+
6074
When a version is auto-detected or defaulted, the command asks for confirmation before checking. If you pass a target that doesn't exist, it offers the latest instead; an unknown current version (or missing versions in a non-interactive shell) is rejected with a hint.
6175

6276
![Demo](documentation/check-updates-379da430.gif)

0 commit comments

Comments
 (0)