Skip to content

Laravel Envoy

介绍

Laravel Envoy 提供了一种简洁、最小化的语法,用于定义在远程服务器上运行的常见任务。使用 Blade 风格的语法,您可以轻松设置部署、Artisan 命令等任务。目前,Envoy 仅支持 Mac 和 Linux 操作系统。

安装

首先,使用 Composer 的 global require 命令安装 Envoy:

php
composer global require laravel/envoy

由于全局 Composer 库有时会导致包版本冲突,您可能希望考虑使用 cgr,它是 composer global require 命令的替代品。cgr 库的安装说明可以在 GitHub 上找到。

exclamation

确保将 ~/.composer/vendor/bin 目录放入您的 PATH 中,以便在终端中运行 envoy 命令时可以找到 envoy 可执行文件。

更新 Envoy

您也可以使用 Composer 来保持 Envoy 安装的最新。发出 composer global update 命令将更新所有全局安装的 Composer 包:

php
composer global update

编写任务

所有的 Envoy 任务都应该在项目根目录的 Envoy.blade.php 文件中定义。以下是一个示例:

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

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

如您所见,文件顶部定义了一个 @servers 数组,允许您在任务声明的 on 选项中引用这些服务器。在 @task 声明中,您应该放置在任务执行时应在服务器上运行的 Bash 代码。

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

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

设置

有时,您可能需要在执行 Envoy 任务之前执行一些 PHP 代码。您可以使用 @setup 指令在执行其他任务之前声明变量和进行其他一般 PHP 工作:

php
@setup
    $now = new DateTime();

    $environment = isset($env) ? $env : "testing";
@endsetup

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

php
@include('vendor/autoload.php')

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

变量

如果需要,您可以使用命令行将选项值传递给 Envoy 任务:

php
envoy run deploy --branch=master

您可以通过 Blade 的 "echo" 语法在任务中访问这些选项。您还可以在任务中使用 if 语句和循环。例如,让我们在执行 git pull 命令之前验证 $branch 变量的存在:

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

@task('deploy', ['on' => 'web'])
    cd site

    @if ($branch)
        git pull origin {{ $branch }}
    @endif

    php artisan migrate
@endtask

故事

故事将一组任务组合在一个方便的名称下,允许您将小而专注的任务组合成大任务。例如,一个 deploy 故事可以通过在其定义中列出任务名称来运行 gitcomposer 任务:

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

@story('deploy')
    git
    composer
@endstory

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

@task('composer')
    composer install
@endtask

一旦故事被编写,您可以像运行典型任务一样运行它:

php
envoy run deploy

多服务器

Envoy 允许您轻松地在多个服务器上运行任务。首先,将其他服务器添加到 @servers 声明中。每个服务器都应分配一个唯一名称。一旦定义了其他服务器,在任务的 on 数组中列出每个服务器:

php
@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 选项:

php
@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

运行任务

要运行在 Envoy.blade.php 文件中定义的任务或故事,执行 Envoy 的 run 命令,并传递您想要执行的任务或故事的名称。Envoy 将运行任务并在任务运行时显示来自服务器的输出:

php
envoy run task

确认任务执行

如果您希望在服务器上运行给定任务之前提示确认,您应该在任务声明中添加 confirm 指令。此选项对于破坏性操作特别有用:

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

通知

Slack

Envoy 还支持在每个任务执行后向 Slack 发送通知。@slack 指令接受一个 Slack 钩子 URL 和一个频道名称。您可以通过在 Slack 控制面板中创建一个 "Incoming WebHooks" 集成来获取您的 webhook URL。您应该将整个 webhook URL 传递给 @slack 指令:

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

您可以提供以下之一作为频道参数:

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