ctf0/package-changelog

show package changeLog on install/update

v1.0.7 2017-10-24 11:48 UTC

README

Latest Stable Version Total Downloads Donate with Bitcoin

usually when a package gets updated, the package owner could possibly add/change/remove something from the configuration file, or could add a new feature that he/she didn't have time to add to the read me yet, or for whatever reason that could potentially effect how the user consume the package.

Therefor PackageChangeLog was made, to help developers keep their packages as user friendly as possible and keep the users up-to-date with new changes as releases gets published.

30776152-e2be70d6-a0a1-11e7-9793-0584a5ecb9f8.png

Installation

  • composer require ctf0/package-changelog

  • (Laravel < 5.5) add the service provider to config/app.php

    'providers' => [
        ctf0\PackageChangeLog\PackageChangeLogServiceProvider::class,
    ]
  • after installation, package will auto-register "Why we need that ?"

    • App\\Providers\\EventServiceProvider::postAutoloadDump @composer.json
    • postAutoloadDump @App\Providers\EventServiceProvider

Usage

  • inside your "package" composer.json

    • add the package as a dependency
    • add "changeLog": "log_folder_name" to extra
    "require": {
        // ...
        "ctf0/package-changelog": "^1.0"
    },
    "extra": {
        // ...
        "changeLog": "logs"
    }
  • inside that folder add the log files

    the version have to be equal "==" to the release tag because we check against that version b4 showing the log. this is useful in-case you didn't add a changeLog for the current published version.

    release tag log file name
    v1.0.0 v1.0.0.txt

Notes

  • we don't use any parser for the log file, so whatever you write in the file will be displayed to the user as it is.

  • This is more of a utility package directed towards developers & to get the best of it you have to add it to your package, however to test it you can install it like any other package & run composer dump-autoload afterwards.