tastysoul / changelog-checker
Composer plugin to check changelog files for breaking changes
Package info
github.com/Martin-Beranek/changelog-checker
Type:composer-plugin
pkg:composer/tastysoul/changelog-checker
Requires
- composer-plugin-api: ^2.0
- ext-ctype: *
Requires (Dev)
- composer/composer: ^2.0
- phpstan/phpstan: ^2.2
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Composer plugin to check changelog files for breaking changes.
Displays warnings about all (or selected plugins) breaking changes when updating packages.
Option to write changes to a file (maybe to check in PRs ...).
Installation
composer require tastysoul/changelog-checker --dev
composer.json should contain the following configuration to allow the plugin to run:
"config": { "allow-plugins": { "tastysoul/changelog-checker": true } }
Settings
In your composer.json, you can configure which plugins to check for breaking changes:
"extra": { "changelog-checker": { "plugins": ["vendor/package-a", "vendor/package-b"] } }
Empty or missing array means all updated packages are checked.
Options
--plugins=vendor/package-a,vendor/package-b
Plugins to check for breaking changes. If not specified, all updated packages are checked.
-a --all-changes
Output all active changelog entries, not only [BC] lines
-w --writeToFile
Write output to file
-v -verbose
Output more information about the process
Usage
composer update
Or with command
composer changelog:check "your/package:1.0.0"