Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 2 months 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 (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T09:06:08.000Z (10 months ago)
- Last Synced: 2024-05-01T07:02:48.892Z (about 2 months ago)
- Topics: changelog, composer, composer-plugin, hacktoberfest, php
- Language: PHP
- Homepage:
- Size: 1.37 MB
- Stars: 585
- Watchers: 11
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: .github/SECURITY.md
Lists
- 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)
- awesome-stars - pyrech/composer-changelogs - :notebook: Display better summary after Composer update (PHP)
- awesome-stars - composer-changelogs
README
# composer-changelogs
[](https://packagist.org/packages/pyrech/composer-changelogs)
[](https://packagist.org/packages/pyrech/composer-changelogs)
[](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.
## 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.