https://github.com/violinist-dev/composer-changelog-fetcher

Get a summary of changes for composer dependency updates
https://github.com/violinist-dev/composer-changelog-fetcher

composer composer-package php

Last synced: 2 months ago
JSON representation

Get a summary of changes for composer dependency updates

• Host: GitHub
• URL: https://github.com/violinist-dev/composer-changelog-fetcher
• Owner: violinist-dev
• License: mit
• Created: 2019-02-26T17:53:06.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-11T13:15:31.000Z (4 months ago)
• Last Synced: 2024-09-11T23:22:48.083Z (4 months ago)
• Topics: composer, composer-package, php
• Language: PHP
• Homepage: https://violinist.io
• Size: 41 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog-fetcher
  • License: LICENSE

Awesome Lists containing this project

README

        
# composer-changelog-fetcher

[![Violinist enabled](https://img.shields.io/badge/violinist-enabled-brightgreen.svg)](https://violinist.io)

[![Test](https://github.com/violinist-dev/composer-changelog-fetcher/actions/workflows/test.yml/badge.svg)](https://github.com/violinist-dev/composer-changelog-fetcher/actions/workflows/test.yml)

[![Coverage Status](https://coveralls.io/repos/github/violinist-dev/composer-changelog-fetcher/badge.svg?branch=master)](https://coveralls.io/github/violinist-dev/composer-changelog-fetcher?branch=master)

[![Packagist](https://img.shields.io/packagist/v/violinist-dev/composer-changelog-fetcher.svg?maxAge=3600)](https://packagist.org/packages/violinist-dev/composer-changelog-fetcher)

[![Packagist](https://img.shields.io/packagist/dt/violinist-dev/composer-changelog-fetcher.svg?maxAge=3600)](https://packagist.org/packages/violinist-dev/composer-changelog-fetcher)

## Installation

You probably want this either as a dev dependency, in which case you would install it like so:

```

composer require --dev violinist-dev/composer-changelog-fetcher

```

Or you might want to install it as a global tool, in which case you would do this:

```

composer global require violinist-dev/composer-changelog-fetcher

```

## Usage

You probably want to invoke this within a project. Let's say you run `composer outdated`:

```

symfony/http-foundation    v3.4.22    v3.4.23    Symfony HttpFoundation Component

```

...and then you want to know what changed. Let's assume your bin directory is in `vendor/bin/`:

```

./vendor/bin/changelog-fetcher fetch -p symfony/http-foundation -f v3.4.22 -t v3.4.23

```

..then you might get output like this:

```

9a96d77: Apply php-cs-fixer rule for array_key_exists() (https://github.com/symfony/http-foundation/commit/9a96d77)

```

You can also get this output as json (in this example piped into `jq` for readability):

```

./vendor/bin/changelog-fetcher fetch -p symfony/http-foundation -f v3.4.22 -t v3.4.23 -d ~/Sites/violinist -o json | jq

[

  {

    "hash": "9a96d77",

    "message": "Apply php-cs-fixer rule for array_key_exists()",

    "link": "https://github.com/symfony/http-foundation/commit/9a96d77"

  }

]

```