Documentation

• composer-changelogs
  • Installation
  • Usage
  • Further documentation
  • Credits
  • License

#composer-changelogs

composer-changelogs is a plugin for Composer. It displays some texts after each Composer update to nicely summarize the modified packages with links to release and compare urls. Just copy it in your commit body and you get a nice description.

#Installation

You can install it either globally:

composer global require "pyrech/composer-changelogs"

or locally:

composer require --dev "pyrech/composer-changelogs"

#Usage

That's it! Composer will enable automatically the plugin as soon it's installed. Just run your Composer updates as usual :)

If you no longer want to display summary, you can either:

• run your Composer command with the option --no-plugins
• uninstall the package

#Further documentation

Here is some documentation about the project:

• Configuration, like gitlab hosts setup
• Experimental autocommit feature

You can see the current and past versions using one of the following:

• the git tag command
• the releases page on Github
• the file listing the changes between versions

And finally some meta documentation:

• versioning and branching models
• contribution instructions

#Credits

• Loïck Piera
• All contributors

Kudos to Damien Alexandre for the idea.

#License

composer-changelogs is licensed under the MIT License - see the LICENSE file for details.