Laravel Envoy

简介
安装
编写任务
- 定义任务
- 多服务器
- 设置
- 变量
- 故事
- 钩子
运行任务
- 确认任务执行
通知

简介

Laravel Envoy 是一个用于执行远程服务器上运行的常见任务的工具。使用 Blade 样式语法，你可以轻松设置部署、Artisan 命令等任务。目前，Envoy 仅支持 Mac 和 Linux 操作系统。但是，可以使用 WSL2 实现 Windows 支持。

安装

首先，使用 Composer 包管理器将 Envoy 安装到你的项目中

composer require laravel/envoy --dev

安装 Envoy 后，Envoy 二进制文件将位于你应用程序的 vendor/bin 目录中

php vendor/bin/envoy

编写任务

定义任务

任务是 Envoy 的基本构建块。任务定义了在调用任务时应在远程服务器上执行的 shell 命令。例如，你可能定义一个在所有应用程序的队列工作服务器上执行 php artisan queue:restart 命令的任务。

你所有的 Envoy 任务都应在你应用程序根目录的 Envoy.blade.php 文件中定义。这是一个入门示例

@servers(['web' => ['[email protected]'], 'workers' => ['[email protected]']])
 
@task('restart-queues', ['on' => 'workers'])
    cd /home/user/example.com
    php artisan queue:restart
@endtask

如你所见，在文件顶部定义了一个 @servers 数组，允许你通过任务声明的 on 选项引用这些服务器。@servers 声明应始终放在一行上。在 @task 声明中，你应放置在调用任务时应在服务器上执行的 shell 命令。

本地任务

你可以通过将服务器的 IP 地址指定为 127.0.0.1 来强制脚本在你的本地计算机上运行

@servers(['localhost' => '127.0.0.1'])

导入 Envoy 任务

使用 @import 指令，你可以导入其他 Envoy 文件，以便将其故事和任务添加到你的文件中。导入文件后，你可以像执行在你的 Envoy 文件中定义的任务一样执行它们包含的任务

@import('vendor/package/Envoy.blade.php')

多服务器

Envoy 允许你轻松地在多台服务器上运行任务。首先，将其他服务器添加到你的 @servers 声明中。每个服务器都应分配一个唯一的名称。定义其他服务器后，你可以在任务的 on 数组中列出每个服务器

@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])
 
@task('deploy', ['on' => ['web-1', 'web-2']])
    cd /home/user/example.com
    git pull origin {{ $branch }}
    php artisan migrate --force
@endtask

并行执行

默认情况下，任务将在每台服务器上串行执行。换句话说，任务将在第一台服务器上完成运行，然后再继续在第二台服务器上执行。如果你希望在多台服务器上并行运行任务，请将 parallel 选项添加到你的任务声明中

@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])
 
@task('deploy', ['on' => ['web-1', 'web-2'], 'parallel' => true])
    cd /home/user/example.com
    git pull origin {{ $branch }}
    php artisan migrate --force
@endtask

设置

有时，你可能需要在运行 Envoy 任务之前执行任意 PHP 代码。你可以使用 @setup 指令来定义在任务之前应执行的 PHP 代码块

@setup
    $now = new DateTime;
@endsetup

如果需要在执行任务之前要求其他 PHP 文件，你可以在 Envoy.blade.php 文件的顶部使用 @include 指令

@include('vendor/autoload.php')
 
@task('restart-queues')
    # ...
@endtask

变量

如果需要，你可以通过在调用 Envoy 时在命令行中指定参数来将参数传递给 Envoy 任务

php vendor/bin/envoy run deploy --branch=master

你可以在任务中使用 Blade 的“echo”语法访问选项。你还可以在任务中定义 Blade if 语句和循环。例如，让我们在执行 git pull 命令之前验证 $branch 变量是否存在

@servers(['web' => ['[email protected]']])
 
@task('deploy', ['on' => 'web'])
    cd /home/user/example.com
 
    @if ($branch)
        git pull origin {{ $branch }}
    @endif
 
    php artisan migrate --force
@endtask

故事

故事将一组任务分组到一个方便的名称下。例如，deploy 故事可以通过在其定义中列出任务名称来运行 update-code 和 install-dependencies 任务

@servers(['web' => ['[email protected]']])
 
@story('deploy')
    update-code
    install-dependencies
@endstory
 
@task('update-code')
    cd /home/user/example.com
    git pull origin master
@endtask
 
@task('install-dependencies')
    cd /home/user/example.com
    composer install
@endtask

编写故事后，你可以像调用任务一样调用它

php vendor/bin/envoy run deploy

钩子

当任务和故事运行时，将执行许多钩子。Envoy 支持的钩子类型有 @before、@after、@error、@success 和 @finished。这些钩子中的所有代码都将解释为 PHP 并在本地执行，而不是在你的任务与之交互的远程服务器上执行。

你可以根据需要定义任意数量的这些钩子。它们将按照它们在你的 Envoy 脚本中出现的顺序执行。

`@before`

在每次任务执行之前，将执行在你的 Envoy 脚本中注册的所有 @before 钩子。@before 钩子接收将要执行的任务的名称

@before
    if ($task === 'deploy') {
        // ...
    }
@endbefore

`@after`

在每次任务执行之后，将执行在你的 Envoy 脚本中注册的所有 @after 钩子。@after 钩子接收已执行的任务的名称

@after
    if ($task === 'deploy') {
        // ...
    }
@endafter

`@error`

在每次任务失败（以大于 0 的状态码退出）后，将执行在你的 Envoy 脚本中注册的所有 @error 钩子。@error 钩子接收已执行的任务的名称

@error
    if ($task === 'deploy') {
        // ...
    }
@enderror

`@success`

如果所有任务都已执行且没有错误，则将执行在你的 Envoy 脚本中注册的所有 @success 钩子

@success
    // ...
@endsuccess

`@finished`

在所有任务都已执行（无论退出状态如何）后，将执行所有 @finished 钩子。@finished 钩子接收已完成任务的状态码，该状态码可能为 null 或大于或等于 0 的 integer

@finished
    if ($exitCode > 0) {
        // There were errors in one of the tasks...
    }
@endfinished

运行任务

要运行在你的应用程序的 Envoy.blade.php 文件中定义的任务或故事，请执行 Envoy 的 run 命令，并传递你要执行的任务或故事的名称。Envoy 将执行该任务并在任务运行时显示来自远程服务器的输出

php vendor/bin/envoy run deploy

确认任务执行

如果你希望在服务器上运行给定任务之前收到确认提示，则应将 confirm 指令添加到你的任务声明中。此选项对于破坏性操作特别有用

@task('deploy', ['on' => 'web', 'confirm' => true])
    cd /home/user/example.com
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

通知

Slack

Envoy 支持在每次任务执行后向 Slack 发送通知。@slack 指令接受一个 Slack Webhook URL 和一个频道/用户名。您可以通过在 Slack 控制面板中创建“Incoming WebHooks”集成来检索您的 Webhook URL。

您应该将整个 Webhook URL 作为 @slack 指令的第一个参数传递。@slack 指令的第二个参数应该是频道名称 (#channel) 或用户名 (@user)。

@finished
    @slack('webhook-url', '#bots')
@endfinished

默认情况下，Envoy 通知将向通知频道发送一条消息，描述已执行的任务。但是，您可以通过向 @slack 指令传递第三个参数来使用自定义消息覆盖此消息。

@finished
    @slack('webhook-url', '#bots', 'Hello, Slack.')
@endfinished

Discord

Envoy 还支持在每次任务执行后向 Discord 发送通知。@discord 指令接受一个 Discord Webhook URL 和一条消息。您可以通过在服务器设置中创建“Webhook”并选择 Webhook 应发布到的频道来检索您的 Webhook URL。您应该将整个 Webhook URL 传递给 @discord 指令。

@finished
    @discord('discord-webhook-url')
@endfinished

Envoy 还支持在每次任务执行后向 Telegram 发送通知。@telegram 指令接受一个 Telegram 机器人 ID 和一个聊天 ID。您可以使用 BotFather 创建一个新机器人来检索您的机器人 ID。您可以使用 @username_to_id_bot 检索有效的聊天 ID。您应该将整个机器人 ID 和聊天 ID 传递给 @telegram 指令。

@finished
    @telegram('bot-id','chat-id')
@endfinished

Envoy 还支持在每次任务执行后向 Microsoft Teams 发送通知。@microsoftTeams 指令接受一个 Teams Webhook (必需)、一条消息、主题颜色 (success, info, warning, error) 以及一个选项数组。您可以通过创建一个新的传入 Webhook 来检索您的 Teams Webhook。Teams API 还有许多其他属性可以自定义您的消息框，例如标题、摘要和部分。您可以在 Microsoft Teams 文档中找到更多信息。您应该将整个 Webhook URL 传递给 @microsoftTeams 指令。

@finished
    @microsoftTeams('webhook-url')
@endfinished