README

此包可以帮助您生成项目生命周期中安装、更新和卸载的依赖项的更改日志。这有助于开发者以可读的方式跟踪重要变更。生成总是生成整个历史，因此可以在需要时手动运行或在CI中运行。

该命令是优秀的composer-lock-diff的集成，由davidrjonas创建。

安装

确保已全局安装Composer，如Composer文档中的安装章节中所述。

打开命令行，进入您的项目目录并执行以下命令

$ composer require idlab/composer-changelog-bundle --dev

打开命令行，进入您的项目目录，并执行以下命令以下载此包的最新稳定版本

$ composer require idlab/composer-changelog-bundle

然后，通过将其添加到项目config/bundles.php文件中注册的包列表中，启用包

// config/bundles.php

return [
    // ...
    Idlab\ComposerChangelogBundle\IdlabComposerChangelogBundle::class => ['dev' => true],
];

$ php bin/console idlab:composer-changelog

将生成类似以下示例的内容

[...]

您还可以将输出重定向到文件，然后将其与您的应用程序一起提交。

$ php bin/console idlab:composer-changelog > COMPOSER-CHANGELOG.md

输出格式和目标可以在配置文件中定义。如果尚未生成文件，则创建一个新的config/packages/idlab_composer_changelog.yaml文件。默认值如下

idlab_composer_changelog:
    # Formats the output, can be "text", "md", "json", "json-pretty"
    format: md

注意：要查看配置参考，请运行$ php bin/console config:dump idlab_composer_changelog

请在提交合并请求之前始终运行CS fixer（PHP CS Fixer位于./vendors目录中）

$ php ./vendor/bin/php-cs-fixer fix