Laravel 8 中文文档 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
如您所见，在文件顶部定义了一个 @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 允许您轻松跨多个服务器运行任务。 首先，在 @server 声明中添加其他服务器。 应为每个服务器分配一个唯一的名称。 定义了其他服务器后，列出任务的 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('foo')
# ...
@endtask
变量
如果需要，您可以运行命令时传递参数到 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.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 钩子 URL 和通道名称。 您可以通过在 Slack 控制面板中创建 Incoming WebHooks 集成来检索您的 webhook URL 。 您应该将整个 webhook URL 传递给 @slack 指令：
@finished
@slack('webhook-url', '#bots')
@endfinished
Discord
Envoy 还支持在执行每项任务后向 Discord 发送通知。@discord 指令接受 Discord 钩子 URL 和消息。 您可以通过在 Webhook 中创建 Webhook 并选择 webhook 应发布到哪个频道来检索您的 webhook URL。 您应该将整个 Webhook URL 传递到 @discord 指令：
@finished
@discord('discord-webhook-url')
@endfinished
Telegram
Envoy还支持向 Telegram 发送通知在执行每个任务后。@telegram 指令接受Telegram Bot ID和Chat ID。您可以使用 BotFather 创建一个新的Bot来检索Bot ID. 您可以使用 @username_to_id_bot 检索有效的聊天ID. 您应该将整个Bot ID和Chat ID传递到 @telegram 指令中：
@finished
@telegram('bot-id','chat-id')
@endfinished