https://github.com/pyrech/composer-changelogs

:notebook: Display better summary after Composer update
https://github.com/pyrech/composer-changelogs

changelog composer composer-plugin hacktoberfest php

Last synced: 6 days ago
JSON representation

:notebook: Display better summary after Composer update

• Host: GitHub
• URL: https://github.com/pyrech/composer-changelogs
• Owner: pyrech
• License: mit
• Created: 2015-09-22T22:13:44.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2023-09-01T09:06:08.000Z (over 1 year ago)
• Last Synced: 2024-11-23T14:46:28.292Z (19 days ago)
• Topics: changelog, composer, composer-plugin, hacktoberfest, php
• Language: PHP
• Homepage:
• Size: 1.37 MB
• Stars: 588
• Watchers: 13
• Forks: 26
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• awesome-composer - Composer-Changelogs - Provides a summary of the updates with links to changelog/releasenote/tag. The output is ready to be pasted into the commit message when updating the composer.lock file. (Plugins / Support)

README

        
# composer-changelogs

[![Total Downloads](https://poser.pugx.org/pyrech/composer-changelogs/downloads)](https://packagist.org/packages/pyrech/composer-changelogs)

[![Latest Stable Version](https://poser.pugx.org/pyrech/composer-changelogs/v/stable)](https://packagist.org/packages/pyrech/composer-changelogs)

[![Latest Unstable Version](https://poser.pugx.org/pyrech/composer-changelogs/v/unstable)](https://packagist.org/packages/pyrech/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.

![Demo](doc/demo.gif)

## Installation

You can install it either globally:

```shell

composer global require "pyrech/composer-changelogs"

```

or locally:

```shell

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](doc/configuration.md)

* [Experimental autocommit feature](doc/autocommit.md)

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

* the `git tag` command

* the [releases page on Github](https://github.com/pyrech/composer-changelogs/releases)

* the file listing the [changes between versions](CHANGELOG.md)

And finally some meta documentation:

* [versioning and branching models](VERSIONING.md)

* [contribution instructions](CONTRIBUTING.md)

## Credits

* [Loïck Piera](https://github.com/pyrech)

* [All contributors](https://github.com/pyrech/composer-changelogs/graphs/contributors)

Kudos to [Damien Alexandre](https://github.com/damienalexandre) for the idea.

## License

composer-changelogs is licensed under the MIT License - see the [LICENSE](LICENSE)

file for details.