PackageChangeLog

KO | EN

gitlite — search

#react #ai #go #android #machine-learning #linux #nodejs #java #windows #awesome #kubernetes #awesome-list #mcp #open-source

PackageChangeLog

(★ 16)

Show Package Changelog On Composer Install/update

PackageChangeLog 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
    PackageChangeLog
    <br>
    <a href="https://packagist.org/packages/ctf0/package-changelog"><img src="https://img.shields.io/packagist/v/ctf0/package-changelog.svg" alt="Latest Stable Version" /></a> <a href="https://packagist.org/packages/ctf0/package-changelog"><img src="https://img.shields.io/packagist/dt/ctf0/package-changelog.svg" alt="Total Downloads" /></a>
</h1>

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](https://getcomposer.org/doc/articles/scripts.md#what-is-a-script-) for more info

```json
    "scripts": {
        "post-install-cmd": [
            "@php artisan pcl:post-install"
        ],
        "post-update-cmd": [
            "@php artisan pcl:post-update"
        ]
    }
    ```

<br>

## Upgrading to v2

- remove `'App\\Providers\\EventServiceProvider::postAutoloadDump'` from `composer.json`
- remove

```php
    /**
    * "ctf0/package-changelog".
    */
    public static function postAutoloadDump(\Composer\Script\Event $event)
    {
       if (class_exists('ctf0\PackageChangeLog\Ops')) {
           return \ctf0\PackageChangeLog\Ops::postAutoloadDump($event);
       }
    }
    ```

from `app\Providers\EventServiceProvider`
- clear the cache `php artisan cache:clear`

<br>

## Usage

- inside your **"package"** composer.json
    + add the package as a dependency
    + add `"changeLog": "log_folder_name"` to extra

```js
    "require": {
        // ...
        "ctf0/package-changelog": "^2.0"
    },
    "extra": {
        // ...
        "changeLog": "logs"
    }
    ```

- 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    |

<br>

## Uninstall

- for whatever reason you decided to remove the package, make sure to remove all the package scripts under `composer.json` before uninstall

```json
"scripts": {
    "post-install-cmd": [
        "@php artisan pcl:post-install"
    ],
    "post-update-cmd": [
        "@php artisan pcl:post-update"
    ]
}
```

## 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.

<br>

### Security

If you discover any security-related issues, please email [ctf0-dev@protonmail.com](mailto:ctf0-dev@protonmail.com).

PackageChangeLog

PackageChangeLog 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

PackageChangeLog

PackageChangeLog 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README