Table of Contents
1、简介
1.1 安装
2、编写任务
2.1 任务变量
2.2 多个服务器
2.3 任务宏
3、运行任务
4、通知
4.1 HipChat
4.2 Slack
Home Backend Development PHP Tutorial [ Laravel 5.2 文档 ] 服务 -- Envoy Task Runner

[ Laravel 5.2 文档 ] 服务 -- Envoy Task Runner

Jun 23, 2016 pm 01:17 PM

1、简介

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

1.1 安装

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

composer global require "laravel/envoy=~1.0"
Copy after login

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

更新Envoy

还可以使用 Composer 保持安装的 Envoy 是最新版本:

composer global update
Copy after login

2、编写任务

所有的 Envoy 任务都定义在项目根目录下的 Envoy.blade.php文件中,下面是一个让你开始的示例:

@servers(['web' => 'user@192.168.1.1'])@task('foo', ['on' => 'web'])    ls -la@endtask
Copy after login

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

启动

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

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

还可以使用 @include来引入外部PHP文件:

@include('vendor/autoload.php');
Copy after login

确认任务

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

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

2.1 任务变量

如果需要的话,你可以使用命令行开关传递变量到Envoy文件,从而允许你自定义任务:

envoy run deploy --branch=master
Copy after login

你可以在任务中通过Blade的“echo”语法使用该选项:

@servers(['web' => '192.168.1.1'])@task('deploy', ['on' => 'web'])    cd site    git pull origin {{ $branch }}    php artisan migrate@endtask
Copy after login

2.2 多个服务器

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

@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
Copy after login

默认情况下,该任务将会依次在每个服务器上执行,这意味着,该任务在第一台服务器上运行完成后才会开始在第二台服务器运行。

平行运行

如果你想要在多个服务器上平行运行,添加 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
Copy after login

2.3 任务宏

宏允许你使用单个命令中定义多个依次运行的任务。例如, deploy宏会运行git和composer任务:

@servers(['web' => '192.168.1.1'])@macro('deploy')    git    composer@endmacro@task('git')    git pull origin master@endtask@task('composer')    composer install@endtask
Copy after login

宏被定义好了之后,你就可以通过如下单个命令运行它:

envoy run deploy
Copy after login

3、运行任务

要从 Envoy.blade.php文件中运行一个任务,需要执行Envoy的 run命令,然后传递你要执行的任务的命令名或宏。Envoy将会运行命令并从服务打印输出:

envoy run task
Copy after login

4、通知

4.1 HipChat

运行完一个任务后,可以使用Envoy的 @hipchat指令发送通知到团队的 HipChat房间,该指令接收一个API令牌、房间名称、和用户名:

@servers(['web' => '192.168.1.1'])@task('foo', ['on' => 'web'])    ls -la@endtask@after    @hipchat('token', 'room', 'Envoy')@endafter
Copy after login

需要的话,你还可以传递自定义发送给HipChat房间的消息,所有在Envoy任务中有效的变量在构建消息时也有效:

@after    @hipchat('token', 'room', 'Envoy', "{$task} ran in the {$env} environment.")@endafter
Copy after login

4.2 Slack

除了HipChat之外,Envoy还支持发送通知到 Slack。 @slack指令接收一个Slack钩子URL、频道名称、和你要发送给该频道的消息:

@after    @slack('hook', 'channel', 'message')@endafter
Copy after login

你可以通过创建集成到Slack网站的Incoming WebHooks来获取钩子URL,该hook参数是由 Incoming Webhooks Slack 集成提供的完整webhook URL,例如:

https://hooks.slack.com/services/ZZZZZZZZZ/YYYYYYYYY/XXXXXXXXXXXXXXX
Copy after login

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

  • 发送消息到频道:  #channel
  • 发送消息到用户:  @user
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
2 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
Repo: How To Revive Teammates
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island Adventure: How To Get Giant Seeds
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

11 Best PHP URL Shortener Scripts (Free and Premium) 11 Best PHP URL Shortener Scripts (Free and Premium) Mar 03, 2025 am 10:49 AM

Long URLs, often cluttered with keywords and tracking parameters, can deter visitors. A URL shortening script offers a solution, creating concise links ideal for social media and other platforms. These scripts are valuable for individual websites a

Introduction to the Instagram API Introduction to the Instagram API Mar 02, 2025 am 09:32 AM

Following its high-profile acquisition by Facebook in 2012, Instagram adopted two sets of APIs for third-party use. These are the Instagram Graph API and the Instagram Basic Display API.As a developer building an app that requires information from a

Working with Flash Session Data in Laravel Working with Flash Session Data in Laravel Mar 12, 2025 pm 05:08 PM

Laravel simplifies handling temporary session data using its intuitive flash methods. This is perfect for displaying brief messages, alerts, or notifications within your application. Data persists only for the subsequent request by default: $request-

Build a React App With a Laravel Back End: Part 2, React Build a React App With a Laravel Back End: Part 2, React Mar 04, 2025 am 09:33 AM

This is the second and final part of the series on building a React application with a Laravel back-end. In the first part of the series, we created a RESTful API using Laravel for a basic product-listing application. In this tutorial, we will be dev

Simplified HTTP Response Mocking in Laravel Tests Simplified HTTP Response Mocking in Laravel Tests Mar 12, 2025 pm 05:09 PM

Laravel provides concise HTTP response simulation syntax, simplifying HTTP interaction testing. This approach significantly reduces code redundancy while making your test simulation more intuitive. The basic implementation provides a variety of response type shortcuts: use Illuminate\Support\Facades\Http; Http::fake([ 'google.com' => 'Hello World', 'github.com' => ['foo' => 'bar'], 'forge.laravel.com' =>

cURL in PHP: How to Use the PHP cURL Extension in REST APIs cURL in PHP: How to Use the PHP cURL Extension in REST APIs Mar 14, 2025 am 11:42 AM

The PHP Client URL (cURL) extension is a powerful tool for developers, enabling seamless interaction with remote servers and REST APIs. By leveraging libcurl, a well-respected multi-protocol file transfer library, PHP cURL facilitates efficient execution of various network protocols, including HTTP, HTTPS, and FTP. This extension offers granular control over HTTP requests, supports multiple concurrent operations, and provides built-in security features.

12 Best PHP Chat Scripts on CodeCanyon 12 Best PHP Chat Scripts on CodeCanyon Mar 13, 2025 pm 12:08 PM

Do you want to provide real-time, instant solutions to your customers' most pressing problems? Live chat lets you have real-time conversations with customers and resolve their problems instantly. It allows you to provide faster service to your custom

Announcement of 2025 PHP Situation Survey Announcement of 2025 PHP Situation Survey Mar 03, 2025 pm 04:20 PM

The 2025 PHP Landscape Survey investigates current PHP development trends. It explores framework usage, deployment methods, and challenges, aiming to provide insights for developers and businesses. The survey anticipates growth in modern PHP versio

See all articles