README

PackageChangeLog

通常，当一个包更新时，包所有者可能会从配置文件中添加、更改或删除某些内容，或者添加一个他/她还没有时间添加到README中的新特性，或者由于任何可能影响用户使用包的原因。

因此，我们创建了 PackageChangeLog，以帮助开发者尽可能保持他们的包对用户友好，并在发布新版本时，让用户了解新更改。

安装

• composer require ctf0/package-changelog

• 安装后，包将自动将以下内容注册到 composer.json

  • 查看 composer 文档 获取更多信息

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

升级到 v:v

• 从 composer.json 中删除 'App\\Providers\\EventServiceProvider::postAutoloadDump'

• 删除

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

  从 app\Providers\EventServiceProvider 中删除

• 清除缓存 php artisan cache:clear

用法

• 在你的 "package" composer.json 中

  • 将包作为依赖项添加
  • 在extra中添加 "changeLog": "log_folder_name"

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

• 在该文件夹中添加日志文件

  • 安装 post-install-cmd

  如果你只想在安装时显示日志，则添加一个名为 install.txt 的文件，我们将在包第一次安装时显示它。

  • 更新 post-update-cmd

  版本必须等于 "==" 发布标签，因为我们检查该版本后再显示日志。

  这在您没有为当前发布的版本添加变更日志时非常有用。

卸载

• 出于任何原因您决定移除该包，请在卸载之前确保从 composer.json 中删除所有包脚本

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

注意

• 我们不使用任何解析器来解析日志文件，所以文件中的任何内容都将原样显示给用户。
• 这是一个更多针对开发者的 实用工具 包，要充分发挥其作用，您需要将其添加到您的包中。但是，为了测试它，您可以像安装其他包一样安装它，您将收到类似于上述截图的消息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件 ctf0-dev@protonmail.com 联系。