[ Laravel 5.3 文档 ] 官方包 —— Envoy Task Runner

1、简介

Laravel Envoy 为运行在远程主机上的通用任务定义提供了一套干净的、最简化的语法。使用Blade风格语法，你可以轻松为开发设置任务，Artisan命令，以及更多，目前，Envoy只支持 Mac 和 Linux 操作系统。

安装

首先，使用 Composer 的 global 命令安装 Envoy：

composer global require "laravel/envoy=~1.0"

由于全局的Composer库有时候会导致包版本冲突，所以需要考虑使用cgr，该命令是composer global require命令的替代实现，cgr库的安装指南可以在 GitHub 上找到。

注：确保 ~/.composer/vendor/bin 目录已经在系统路径PATH中，否则在终端中由于找不到 envoy 而无法执行该命令。

更新Envoy

还可以使用 Composer 保持安装的 Envoy 是最新版本，因为 composer global update 命令将会更新所有全局安装的Composer包：

composer global update

2、编写任务

所有的 Envoy 任务都定义在项目根目录下的 Envoy.blade.php 文件中，下面是一个让你上手的示例：

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

@task('foo', ['on' => 'web'])
    ls -la
@endtask

正如你所看到的， @servers 数组定义在文件顶部，从而允许你在任务声明中使用 on 选项引用这些服务器，在  @task 声明中，应该放置将要在服务器上运行的Bash代码。

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

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

起步

有时候，你需要在执行Envoy任务之前执行一些PHP代码，可以在Envoy文件中使用 @setup 指令来声明变量和要执行的PHP代码：

@setup
    $now = new DateTime();
    $environment = isset($env) ? $env : "testing";
@endsetup

如果你需要在任务执行之前引入其它PHP文件，可以在 Envoy.blade.php 文件顶部使用 @include 来引入：

@include('vendor/autoload.php')

@task('foo')
    # ...
@endtask

变量

如果需要的话，你可以使用命令行传递选项值到Envoy任务：

envoy run deploy --branch=master

你可以在任务中通过Blade的“echo”语法访问该选项，当然，你还可以使用 if 语句并在任务中循环，例如，下面我们在执行 git pull 命令前验证 $branch 变量是否存在：

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

@task('deploy', ['on' => 'web'])
    cd site
    @if ($branch)
        git pull origin {{ $branch }}
    @endif
    php artisan migrate
@endtask

Story

story通过一个便捷的名字对任务集合进行分组，从而允许你将小而专注的任务组合成大的任务，例如， deploy story将会通过在其定义中罗列任务名的方式运行git和composer任务：

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

@story('deploy')
    git
    composer
@endstory

@task('git')
    git pull origin master
@endtask

@task('composer')
    composer install
@endtask

story被编写好之后，就可以像普通任务一样运行：

envoy run deploy

多个服务器

你可以轻松地在多主机上运行同一个任务，首先，添加额外服务器到 @servers 声明，每个服务器应该被指配一个唯一的名字。定义好服务器后，在任务的 on 数组中列出所有服务器即可：

@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])

@task('deploy', ['on' => ['web-1', 'web-2']])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@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 site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

3、运行任务

要运行一个在 Envoy.blade.php 文件中定义的任务，需要执行Envoy的 run 命令，然后传递你要执行的任务或story的名字。Envoy将会运行命令并从服务打印输出：

envoy run task

确认任务执行

如果你想要在服务器上运行给定任务之前弹出弹出提示进行确认，可以在任务声明中使用 confirm 指令：

@task('deploy', ['on' => 'web', 'confirm' => true])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

4、通知

Slack

Envoy还支持在任务执行之后发送通知到 Slack 。 @slack 指令接收一个Slack钩子URL和频道名称，你可以通过在Slack控制面板中创建“Incoming WebHooks”集成来获取webhook URL，需要传递完整的webhook URL到 @slack 指令：

@after
    @slack('webhook-url', '#bots')
@endafter

你可以提供下面两种其中之一作为频道参数：

• 发送通知到频道:  #channel
• 发送通知到用户:  @user