Download the PHP package xavierleune/php-changelog-generator without Composer
On this page you can find all versions of the php package xavierleune/php-changelog-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xavierleune/php-changelog-generator
More information about xavierleune/php-changelog-generator
Files in xavierleune/php-changelog-generator
Package php-changelog-generator
Short Description PHP tool to detect API changes and generate changelog with SemVer compliance
License MIT
Informations about the package php-changelog-generator
PHP Changelog Generator
A PHP tool to automatically detect API changes between two versions of a PHP project and generate a changelog following SemVer principles.
Features
- ✅ Analysis of public elements only (classes, interfaces, methods, functions, constants)
- ✅ Support for native PHP signatures and PHPDoc
- ✅ Detection of compatible/incompatible changes
- ✅ Automatic SemVer recommendations (major/minor/patch)
- ✅ Markdown changelog generation
- ✅ Support for exclusion patterns
- ✅ Compatible with PHP 7.4+ for analysis, PHP 8.3+ for execution
Installation
Usage
Basic command
Available options
Examples
SemVer Rules
Major Changes (Breaking Changes)
- Removed methods/functions
- Incompatible signatures (required parameters added, types changed)
- Removed classes/interfaces
- Modified/removed constants
- Restrictive visibility changes
Minor Changes (Backward Compatible)
- New methods/functions/classes
- Optional parameters added
- New implemented interfaces
- New constants
Patch Changes
- PHPDoc modifications without signature impact
- Internal changes without public API impact
Pre-1.0.0 SemVer Behavior
By default, for versions before 1.0.0 (e.g., 0.x.y), this tool follows a relaxed SemVer approach:
- Breaking changes (normally major) are treated as minor changes
- New features remain minor changes
- Bug fixes remain patch changes
This reflects the common practice that pre-1.0.0 versions are in development and breaking changes are expected.
Strict SemVer Mode
Use the --strict-semver flag to enforce standard SemVer rules even for pre-1.0.0 versions:
PHPDoc Analysis
The tool prioritizes native PHP signature analysis but uses PHPDoc as fallback:
- If PHP signature is typed → uses the signature
- If only PHPDoc is typed → uses PHPDoc
- In case of conflict → logs a warning and uses the signature
Architecture
Development
Tests
Code standards
Static analysis
License
MIT
All versions of php-changelog-generator with dependencies
nikic/php-parser Version ^5.0
symfony/console Version ^7.0
phpstan/phpdoc-parser Version ^2.1