Laravel Envoy

简介
安装
编写任务
运行任务
- 确认任务执行
通知

简介

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

安装

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

1composer require laravel/envoy --dev

composer require laravel/envoy --dev

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

1php vendor/bin/envoy

php vendor/bin/envoy

编写任务

定义任务

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

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

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

@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 来强制脚本在本地计算机上运行。

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

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

导入 Envoy 任务

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

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

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

多服务器

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

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

@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 选项。

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

@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 代码块。

1@setup
2    $now = new DateTime;
3@endsetup

@setup
    $now = new DateTime;
@endsetup

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

1@include('vendor/autoload.php')
2 
3@task('restart-queues')
4    # ...
5@endtask

@include('vendor/autoload.php')

@task('restart-queues')
    # ...
@endtask

变量

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

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

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

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

 1@servers(['web' => ['[email protected]']])
 2 
 3@task('deploy', ['on' => 'web'])
 4    cd /home/user/example.com
 5 
 6    @if ($branch)
 7        git pull origin {{ $branch }}
 8    @endif
 9 
10    php artisan migrate --force
11@endtask

@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

故事 (Stories)

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

 1@servers(['web' => ['[email protected]']])
 2 
 3@story('deploy')
 4    update-code
 5    install-dependencies
 6@endstory
 7 
 8@task('update-code')
 9    cd /home/user/example.com
10    git pull origin master
11@endtask
12 
13@task('install-dependencies')
14    cd /home/user/example.com
15    composer install
16@endtask

@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

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

1php vendor/bin/envoy run deploy

php vendor/bin/envoy run deploy

钩子 (Hooks)

当任务和故事运行时，会触发一系列钩子。Envoy 支持的钩子类型包括 @before、@after、@error、@success 和 @finished。这些钩子中的所有代码都会被视为 PHP 并于本地执行，而不是在你任务所交互的远程服务器上执行。

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

`@before`

在每个任务执行之前，脚本中注册的所有 @before 钩子都将执行。@before 钩子会接收即将执行的任务名称。

1@before
2    if ($task === 'deploy') {
3        // ...
4    }
5@endbefore

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

`@after`

在每个任务执行之后，脚本中注册的所有 @after 钩子都将执行。@after 钩子会接收刚刚执行完毕的任务名称。

1@after
2    if ($task === 'deploy') {
3        // ...
4    }
5@endafter

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

`@error`

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

1@error
2    if ($task === 'deploy') {
3        // ...
4    }
5@enderror

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

`@success`

如果所有任务都成功执行且没有错误，脚本中注册的所有 @success 钩子都将执行。

1@success
2    // ...
3@endsuccess

@success
    // ...
@endsuccess

`@finished`

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

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

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

运行任务

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

1php vendor/bin/envoy run deploy

php vendor/bin/envoy run deploy

确认任务执行

如果你希望在服务器上运行特定任务前进行确认，可以在任务声明中添加 confirm 指令。此选项对于破坏性操作特别有用。

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

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

通知

Slack

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

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

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

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

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

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

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

Discord

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

1@finished
2    @discord('discord-webhook-url')
3@endfinished

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

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

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

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

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

1@finished
2    @microsoftTeams('webhook-url')
3@endfinished

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