Laravel Envoy

• 簡介
• 安裝
• 編寫任務
  • 定義任務
  • 多台伺服器
  • 設定
  • 變數
  • 故事
  • 完成鉤子
• 執行任務
  • 確認任務執行
• 通知
  • Slack
  • Discord
  • Telegram
  • Microsoft Teams

簡介

Laravel Envoy 是一個用於在遠端伺服器上執行常見任務的工具。使用 Blade 風格的語法，您可以輕鬆設定部署任務、Artisan 命令等。目前，Envoy 僅支援 Mac 和 Linux 作業系統。但是，可以使用 WSL2 來實現 Windows 支援。

安裝

首先，使用 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' => ['[email protected]'], 'workers' => ['[email protected]']])

@task('restart-queues', ['on' => 'workers'])
    cd /home/user/example.com
    php artisan queue:restart
@endtask

如您所見，檔案頂部定義了一個 @servers 陣列，允許您透過任務聲明的 on 選項來引用這些伺服器。在 @task 聲明中，您應該放置在呼叫任務時應在伺服器上執行的 shell 命令。

本機任務

您可以透過將伺服器的 IP 位址指定為 127.0.0.1 來強制腳本在本機電腦上執行：

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

匯入 Envoy 任務

使用 @import 指令，您可以匯入其他 Envoy 檔案，使其故事和任務新增到您的檔案中。檔案匯入後，您可以像在自己的 Envoy 檔案中定義一樣執行它們包含的任務：

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

多台伺服器

Envoy 允許您輕鬆地在多台伺服器上執行任務。首先，將額外的伺服器新增到 @servers 聲明中。每個伺服器應分配一個唯一的名稱。定義額外的伺服器後，您可以在任務的 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('restart-queues')
    # ...
@endtask

變數

如有需要，您可以在呼叫 Envoy 時透過在命令列上指定參數來將其傳遞給 Envoy 任務：

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

您可以使用 Blade 的「echo」語法在任務中存取選項。您還可以在任務中定義 Blade if 陳述式和迴圈。例如，讓我們在執行 git pull 命令之前驗證 $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

故事

故事將一組任務組合在一個方便的名稱下。例如，一個 deploy 故事可以透過在其定義中列出任務名稱來執行 update-code 和 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 支援的鉤子類型有 @before、@after、@error、@success 和 @finished。這些鉤子中的所有程式碼都被解釋為 PHP 並在本機執行，而不是在任務互動的遠端伺服器上執行。

您可以隨意定義任意數量的這些鉤子。它們將按照在 Envoy 腳本中出現的順序執行。

@before

在每次任務執行之前，Envoy 腳本中註冊的所有 @before 鉤子都將執行。@before 鉤子接收將要執行的任務名稱：

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

@after

在每次任務執行之後，Envoy 腳本中註冊的所有 @after 鉤子都將執行。@after 鉤子接收已執行的任務名稱：

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

@error

每次任務失敗後（以大於 0 的狀態代碼退出），Envoy 腳本中註冊的所有 @error 鉤子都將執行。@error 鉤子接收已執行的任務名稱：

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

@success

如果所有任務都已成功執行且沒有錯誤，Envoy 腳本中註冊的所有 @success 鉤子都將執行：

@success
    // ...
@endsuccess

@finished

在所有任務執行完畢後（無論退出狀態如何），所有 @finished 鉤子都將執行。@finished 鉤子接收已完成任務的狀態代碼，該代碼可能為 null 或大於或等於 0 的整數：

@finished
    if ($exitCode > 0) {
        // There were errors in one of the tasks...
    }
@endfinished

執行任務

要執行在應用程式的 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 webhook URL 和一個頻道 / 使用者名稱。您可以透過在 Slack 控制面板中建立「Incoming WebHooks」整合來取得您的 webhook URL。

您應該將整個 webhook URL 作為傳遞給 @slack 指令的第一個參數。傳遞給 @slack 指令的第二個參數應為頻道名稱（#channel）或使用者名稱（@user）：

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

預設情況下，Envoy 通知將向通知頻道傳送一條描述已執行任務的訊息。但是，您可以透過向 @slack 指令傳遞第三個參數來用您自己的自訂訊息覆寫此訊息：

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

Discord

Envoy 還支援在每次任務執行後向 Discord 傳送通知。@discord 指令接受一個 Discord webhook URL 和一條訊息。您可以透過在伺服器設定中建立「Webhook」並選擇 webhook 應發送到哪個頻道來取得您的 webhook URL。您應該將整個 Webhook URL 傳入 @discord 指令：

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

Telegram

Envoy 還支援在每次任務執行後向 Telegram 傳送通知。@telegram 指令接受一個 Telegram Bot ID 和一個 Chat ID。您可以透過使用 BotFather 建立一個新機器人來取得您的 Bot ID。您可以使用 @username_to_id_bot 取得有效的 Chat ID。您應該將整個 Bot ID 和 Chat ID 傳入 @telegram 指令：

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

Microsoft Teams

Envoy 還支援在每次任務執行後向 Microsoft Teams 傳送通知。@microsoftTeams 指令接受一個 Teams Webhook（必需）、一條訊息、主題顏色（success、info、warning、error）和一個選項陣列。您可以透過建立新的傳入 webhook 來取得您的 Teams Webhook。Teams API 有许多其他屬性可以用來自訂您的訊息框，如標題、摘要和區段。您可以在 Microsoft Teams 文件中找到更多資訊。您應該將整個 Webhook URL 傳入 @microsoftTeams 指令：

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