Envoy laravel laravelphp 中文文档

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

简介

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

安装

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

composer require laravel/envoy --dev

安装 Envoy 后，Envoy 二进制文件将可在你的应用程序的 php vendor/bin 目录中找到：

php vendor/bin/envoy

编写任务

定义任务

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

你所有的 Envoy 任务都应在应用程序根目录下的 php 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

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

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

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

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

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

多服务器

Envoy 允许你轻松地在多个服务器上运行任务。首先，将其他服务器添加到你的 php @servers 声明中。每个服务器应分配一个唯一的名称。定义其他服务器后，可以在任务的 php 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

并行执行
默认情况下，任务将按顺序在每个服务器上执行。换句话说，任务将在第一个服务器上完成运行后才继续在第二个服务器上执行。如果你希望在多个服务器上并行运行任务，请在任务声明中添加 php 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 代码。你可以使用 php @setup 指令定义一个应在任务之前执行的 PHP 代码块：

@setup
    $now = new DateTime;
@endsetup

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

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

变量

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

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

你可以在任务中使用 Blade 的「echo」语法访问这些选项。还可以在任务中定义 Blade 的 php if 语句和循环。例如，让我们在执行 php git pull 命令之前验证 php $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

故事

故事将一组任务分组在一个方便的名称下。例如，php deploy 故事可以通过在其定义中列出任务名称来运行 php update-code 和 php 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 支持的钩子类型有 php @before、php @after、php @error、php @success 和 php @finished。这些钩子中的所有代码都被解释为 PHP 并在本地执行，而不是在任务与之交互的远程服务器上执行。

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

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

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

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

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

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

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

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

@success
    // ...
@endsuccess

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

@finished
    if ($exitCode > 0) {
        // 其中一项任务出错了...
    }
@endfinished

运行任务

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

php vendor/bin/envoy run deploy

确认任务执行

如果你想要在运行给定任务之前提示确认，应在任务声明中添加 php confirm 指令。此选项对于破坏性操作特别有用：

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

通知

Slack

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

你应将整个 Webhook URL 作为传递给 php @slack 指令的第一个参数。传递给 php @slack 指令的第二个参数应是一个频道名称（php #channel）或用户名（php @user）：

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

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

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

Discord

Envoy 还支持在每个任务执行后发送通知到 Discord。php @discord 指令接受一个 Discord 钩子 URL 和一个消息。你可以通过在你的服务器设置中创建一个「Webhook」并选择 Webhook 应发到的频道来获取你的 Webhook URL。你应将整个 Webhook URL 传递给 php @discord 指令：

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

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

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

Microsoft Teams

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

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