2017 © Pedro Peláez
 

library package-changelog

show package changeLog on install/update

image

ctf0/package-changelog

show package changeLog on install/update

  • Wednesday, July 18, 2018
  • by ctf0
  • Repository
  • 1 Watchers
  • 15 Stars
  • 1,505 Installations
  • PHP
  • 9 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 10 Versions
  • 35 % Grown

The README.md

PackageChangeLog
Latest Stable Version Total Downloads

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., (*1)

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., (*2)

, (*3)

Installation

  • composer require ctf0/package-changelog, (*4)

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

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

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


, (*7)

Usage

  • inside your "package" composer.json, (*8)

    • 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, (*9)

    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., (*10)

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


, (*11)

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., (*12)

  • 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., (*13)

The Versions

18/07 2018

dev-master

9999999-dev https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

05/05 2018

dev-patch

dev-patch https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

  • php ~7.0

 

by Muah

ctf0 package-changelog

24/10 2017

v1.0.7

1.0.7.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

22/10 2017

v1.0.6

1.0.6.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

17/09 2017

v1.0.5

1.0.5.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

16/09 2017

v1.0.4

1.0.4.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

15/09 2017

v1.0.3

1.0.3.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

14/09 2017

v1.0.2

1.0.2.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

14/09 2017

v1.0.1

1.0.1.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog

14/09 2017

v1.0.0

1.0.0.0 https://github.com/ctf0/PackageChangeLog

show package changeLog on install/update

  Sources   Download

MIT

The Requires

 

by Muah

laravel ctf0 package-changelog