Download the PHP package ctf0/package-changelog without Composer
On this page you can find all versions of the php package ctf0/package-changelog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ctf0/package-changelog
More information about ctf0/package-changelog
Files in ctf0/package-changelog
Package package-changelog
Short Description show package changeLog on install/update
License MIT
Homepage https://github.com/ctf0/PackageChangeLog
Informations about the package package-changelog
PackageChangeLog
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.
Installation
composer require ctf0/package-changelog
- after installation, package will auto-register the below to
composer.json
- check composer docs for more info
Upgrading to v:v:
- remove
'App\\Providers\\EventServiceProvider::postAutoloadDump'
fromcomposer.json
-
remove
from
app\Providers\EventServiceProvider
- clear the cache
php artisan cache:clear
Usage
-
inside your "package" composer.json
- add the package as a dependency
- add
"changeLog": "log_folder_name"
to extra
-
inside that folder add the log files
- install
post-install-cmd
if you want to show a log on installation only, then add a file name
install.txt
and we will display it only when the package gets installed for the first time.
release tag log file name * install.txt - update
post-update-cmd
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 - install
Uninstall
- for whatever reason you decided to remove the package, make sure to remove all the package scripts under
composer.json
before uninstall
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 & you would get a message like the screenshot above.
Security
If you discover any security-related issues, please email [email protected].