Laravel Envoy

简介

Laravel Envoy 是一套在远程服务器上执行日常任务的工具。 使用 Blade 风格语法，你可以轻松地配置部署任务、Artisan 命令的执行等。目前， Envoy 仅支持 Mac 和 Linux 操作系统。但是， Windows 上可以使用 WSL2 来实现支持。

安装

首先，运行 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' => ['user@192.168.1.1'], 'workers' => ['user@192.168.1.2']])

@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

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

本地任务

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

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

导入 Envoy 任务

使用 @import 指令，你可以从其他的 Envoy 文件导入它们的故事与任务并添加到你的文件中。文件导入后，你可以执行他们所定义的任务，就像这些任务是在你的 Envoy 文件中被定义的一样：

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

配置

有时，你可能需要在执行 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」语法访问传入任务中的命令行参数。你也可以在任务中使用 if 语句和循环。 例如，在执行 git pull 命令之前，我们先验证 $branch 变量是否存在：

@servers(['web' => ['user@192.168.1.1']])

@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' => ['user@192.168.1.1']])

@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, and @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 支持的钩子类型有 @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 文件中定义的任务或 story，请执行 Envoy 的 run 命令，传递你想要执行的任务或 story 的名称。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 钩子 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

Telegram

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

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

Microsoft Teams

Envoy 还支持在每个任务执行后向 Microsoft Teams 发送通知。@microsoftTeams 指令接受Teams Webhook（必填）、消息、主题颜色（成功、信息、警告、错误）和一组选项。你可以通过创建新的 incoming webhook 来检索Teams Webhook。Teams API 有许多其他属性可以自定义消息框，例如标题、摘要和部分。你可以在 Microsoft Teams文档 中找到更多信息。你应该将整个Webhook URL 传递到 @microsoftTeams 指令中：

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