Skip to content

plan2net/typo3-update-check

Repository files navigation

TYPO3 Update Check

CI Latest Version PHP Version License Downloads

A Composer plugin that intercepts TYPO3 core updates and displays breaking changes and security updates before proceeding.

Purpose

Breaking changes and security fixes are easy to overlook when updating TYPO3. This plugin brings that information directly to your terminal the moment you run composer update, highlighting breaking changes (⚠️) and security updates (⚡) so you can make an informed decision before proceeding.

Installation

composer require --dev plan2net/typo3-update-check
composer config allow-plugins.plan2net/typo3-update-check true

Note

Composer 2.2+ requires plugins to be explicitly trusted. The second command adds the necessary entry to your composer.json. When running composer require interactively, Composer will prompt you to allow the plugin — answering yes has the same effect.

Warning

Install this plugin as a development dependency only. It is only useful during development when running composer update; production deployments typically use composer install with locked versions. If you choose to install it in production environments, you do so at your own risk.

How it works

The plugin automatically activates during composer update and:

  1. Detects TYPO3 core updates — Monitors when typo3/cms-core is being updated
  2. Fetches release information — Retrieves data from the TYPO3 API for all versions between current and target
  3. Analyzes security bulletins — Fetches severity levels (Critical, High, Medium, Low) from TYPO3 security advisories
  4. Displays important changes — Shows each affected version's breaking changes and security updates, followed by a one-line digest (releases scanned, security updates with severity totals, breaking changes)
  5. Warns about skipped security fixes — If the target lands below newer security releases, it lists them so you can raise your constraint
  6. Requests confirmation — Prompts before proceeding when breaking changes or security updates are found

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.

Example output

Demo

Manual check

You can check for breaking changes and security updates between any two versions without running an actual update:

composer typo3:check-updates 13.4.10 13.4.12

Both arguments are optional. With no arguments it uses your installed typo3/cms-core version and the latest release in that line; with only the first it defaults the target to the latest:

composer typo3:check-updates             # installed version → latest release
composer typo3:check-updates 13.4.10     # 13.4.10 → latest release

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.

Demo

API availability

The plugin tolerates transient TYPO3 API issues automatically:

  • Bounded retry: each request is retried up to two times (three attempts total) on connection errors, timeouts, HTTP 5xx, and HTTP 429 responses. Backoff is exponential (1 s, 2 s) and honors the server's Retry-After header when present, capped at 5 s so a composer update is never delayed for long.
  • No retry on deterministic errors: HTTP 4xx responses other than 429 are treated as final and reported immediately.
  • Per-version reporting: when only some versions fail to fetch, the others are still shown. Each failure is categorized — network error, server error, not found, or malformed response — and the plugin suggests retrying with composer typo3:check-updates for the skipped versions.
  • Fail-soft: if every request fails after retries, the plugin reports the dominant failure category and lets the update proceed so your development workflow is never blocked.

Caching

API responses are cached to improve performance and reduce load on TYPO3 servers:

  • Location — Composer's global cache directory (~/.cache/composer on Linux/macOS, %LOCALAPPDATA%\Composer on Windows)
  • Release lists — 1 hour
  • Release content and security bulletins — Permanent (content never changes)

The cache is shared across all TYPO3 projects on the same machine.

Requirements

  • PHP 8.1+
  • Composer 2.0+

License

GPL-2.0+

About

Composer plugin to detect breaking changes and security updates during TYPO3 CMS core updates

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages