README

本包提供了一些基本方法，用于实现Laravel 5应用程序的自更新功能。已经内置了通过GitHub提供自更新机制的方法。

通常在分发需要更新机制但不需要Composer的自托管Laravel应用程序时，您需要这个包。

安装

使用Composer从master安装最新版本

$ composer require codedge/laravel-selfupdater

配置

安装包后，您需要通过以下方式发布配置文件：

$ php artisan vendor:publish --provider="Codedge\Updater\UpdaterServiceProvider"

注意：如果您想使用GitHub作为更新源，请确保在您的config/self-updater.php文件中正确输入供应商和仓库名称。

ℹ️ 设置当前安装版本

在开始更新之前，请确保正确设置已安装的版本。您负责设置当前已安装的版本，无论是在配置文件中还是在更好的env变量SELF_UPDATER_VERSION_INSTALLED中。

基于标签的更新

将已安装的版本设置为发布中设置的标签之一。

基于分支的更新

将已安装的版本设置为最新提交的时间戳。
有效的版本可以是： 2020-04-19T22:35:48Z

运行Artisan命令

可以在更新过程前后运行Artisan命令，并在config/self-updater.php中配置。

示例

'artisan_commands' => [
    'pre_update' => [
        'updater:prepare' => [
            'class' => \App\Console\Commands\PreUpdateTasks::class,
            'params' => []
        ],
    ],
    'post_update' => [
        'postupdate:cleanup' => [
            'class' => \App\Console\Commands\PostUpdateCleanup::class,
            'params' => [
                'log' => 1,
                'reset' => false,
                // etc.
            ]
        ]
    ]
]

配置下载路径

有时您的网络主机不允许将文件保存到服务器的/tmp文件夹中。您可以通过设置env变量SELF_UPDATER_DOWNLOAD_PATH为不同的值来更改应用程序下载到的文件夹。但请记住，该文件夹不在您的应用程序所在的文件夹内，因为在更新过程中可能会被覆盖。

通过电子邮件通知

您需要指定一个接收者电子邮件地址和一个接收者姓名以接收更新可用通知。您可以通过在.env文件中添加SELF_UPDATER_MAILTO_NAME和SELF_UPDATER_MAILTO_ADDRESS来指定这些值。

私有仓库

私有仓库可以通过（Bearer）令牌访问。配置文件中的每个仓库都应该有一个private_access_token字段，您可以在其中设置令牌。

注意：请勿在令牌前添加Bearer 前缀。这会自动完成。

用法

要开始更新过程，例如在控制器中，只需使用

Route::get('/', function (\Codedge\Updater\UpdaterManager $updater) {

    // Check if new version is available
    if($updater->source()->isNewVersionAvailable()) {

        // Get the current installed version
        echo $updater->source()->getVersionInstalled();

        // Get the new version available
        $versionAvailable = $updater->source()->getVersionAvailable();

        // Create a release
        $release = $updater->source()->fetch($versionAvailable);

        // Run the update process
        $updater->source()->update($release);

    } else {
        echo "No new version available.";
    }

});

目前，源代码的获取是一个同步过程。它不是在后台运行的。

使用GitHub

本包包含一个Github源代码仓库类型，用于从GitHub获取发布版本 - 实际上是使用GitHub拉取软件的最新版本。

只需确保在您的config/self-updater.php文件中设置了正确的仓库。

基于标签的更新

这是默认选项。更新将通过使用标记提交，即发布来获取。

基于分支的更新

通过配置文件中的use_branch设置内部配置来选择要使用的分支。

// ...
'repository_types' => [
    'github' => [
        'type' => 'github',
        'repository_vendor' => env('SELF_UPDATER_REPO_VENDOR', ''),
        'repository_name' => env('SELF_UPDATER_REPO_NAME', ''),
        // ...
        'use_branch' => 'v2',
   ],
   // ...
];

使用HTTP存档

本包包含一个Http源代码仓库类型，用于从包含zip存档的HTTP目录列表中获取发布版本。

要使用HTTP存档运行，请在您的.env文件中使用以下设置

归档URL应仅包含简单的目录列表以及对应的zip存档。

SELF_UPDATER_PKG_FILENAME_FORMAT 包含所有webapp更新包的文件名格式。例如，当归档URL上列出的更新包具有如 webapp-v1.2.0.zip、webapp-v1.3.5.zip 等名称时，格式应为 webapp-v_VERSION_。其中 _VERSION_ 部分用作语义版本号的变量，用于 MAJOR.MINOR.PATCH 版本号。zip扩展名将自动添加。

目标归档文件必须是zip存档，并且应包含根目录上的所有文件，而不是包含在以归档本身命名的额外文件夹中。

贡献

请参阅贡献指南。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。