Send Slack Notification on Deployment

app/Commands/ProvisionCommand.php

@@ -14,6 +14,7 @@
 namespace App\Commands;
 
 use App\Services\Forge\ForgeService;
+use App\Services\Forge\Pipeline\AnnounceSiteOnSlack;
 use App\Services\Forge\Pipeline\CreateDatabase;
 use App\Services\Forge\Pipeline\DeploySite;
 use App\Services\Forge\Pipeline\EnableQuickDeploy;
@@ -58,6 +59,7 @@ public function handle(ForgeService $service): void
                 RunOptionalCommands::class,
                 EnsureJobScheduled::class,
                 PutCommentOnPullRequest::class,
+                AnnounceSiteOnSlack::class,
             ])
             ->then(function () use ($service) {
                 $this->success('Provisioning complete! Your environment is now set up and ready to use.');

app/Notifications/SiteProvisionedNotification.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of Laravel Harbor.
+ *
+ * (c) Mehran Rasulian <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace App\Notifications;
+
+use App\Services\Forge\ForgeService;
+use Illuminate\Notifications\Notification;
+use Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock;
+use Illuminate\Notifications\Slack\SlackChannel;
+use Illuminate\Notifications\Slack\SlackMessage;
+
+class SiteProvisionedNotification extends Notification
+{
+    public function __construct(protected ForgeService $service)
+    {
+        //
+    }
+
+    public function via(object $notifiable): array
+    {
+        return [SlackChannel::class];
+    }
+
+    public function toSlack(object $notifiable): SlackMessage
+    {
+        return (new SlackMessage)
+            ->to($this->service->setting->slackChannel)
+            ->text('A new site has been provisioned!')
+            ->sectionBlock(function (SectionBlock $block) {
+                $block->text('An preview site has been deployed with Laravel Harbor');
+
+                $block->field("*Branch Name:*\n{$this->service->setting->branch}")->markdown();
+                $block->field("*Environment URL:*\n{$this->service->getSiteLink()}")->markdown();
+            })
+            ->dividerBlock()
+            ->sectionBlock(function (SectionBlock $block) {
+                $block->text('Congratulations!');
+            });
+    }
+}

app/Services/Forge/ForgeSetting.php

@@ -162,6 +162,21 @@ class ForgeSetting
      */
     public ?string $environmentUrl;
 
+    /**
+     * Is the Slack integration enabled?
+     */
+    public bool $slackAnnouncementEnabled;
+
+    /**
+     * The OAuth Token for the Slack Bot
+     */
+    public ?string $slackBotUserOauthToken;
+
+    /**
+     * Which channel to announce to on Slack
+     */
+    public ?string $slackChannel;
+
     /**
      * The validation rules.
      */
@@ -191,6 +206,9 @@ class ForgeSetting
         'git_token' => ['exclude_if:git_comment_enabled,false', 'required', 'string'],
         'subdomain_name' => ['nullable', 'string', 'regex:/^[a-zA-Z0-9-_]+$/'],
         'environment_url' => ['nullable', 'url'],
+        'slack_announcement_enabled' => ['required', 'boolean'],
+        'slack_bot_user_oauth_token' => ['exclude_if:slack_announcement_enabled,false', 'required', 'string'],
+        'slack_channel' => ['exclude_if:slack_announcement_enabled,false', 'required', 'string'],
     ];
 
     public function __construct()

app/Services/Forge/Pipeline/AnnounceSiteOnSlack.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of Laravel Harbor.
+ *
+ * (c) Mehran Rasulian <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace App\Services\Forge\Pipeline;
+
+use App\Notifications\SiteProvisionedNotification;
+use App\Services\Forge\ForgeService;
+use App\Traits\Outputifier;
+use Closure;
+use Illuminate\Notifications\Slack\SlackChannel;
+use Illuminate\Notifications\Slack\SlackRoute;
+use Illuminate\Support\Facades\Notification;
+
+class AnnounceSiteOnSlack
+{
+    use Outputifier;
+
+    public function __invoke(ForgeService $service, Closure $next)
+    {
+        // End early if the slack bot token and channel are not set in the Forge service settings
+        if (! $service->setting->slackAnnouncementEnabled) {
+            return $next($service);
+        }
+
+        if (! $service->siteNewlyMade) {
+            $this->information('Skipping Slack announcement as the site is not newly made.');
+
+            return $next($service);
+        }
+
+        $this->information('Announce the site on Slack.');
+
+        Notification::route(
+            SlackChannel::class,
+            new SlackRoute()
+        )->notify(
+            (new SiteProvisionedNotification($service))
+        );
+
+        return $next($service);
+    }
+}

composer.json

@@ -23,6 +23,7 @@
         "illuminate/validation": "^10.24",
         "laravel-zero/framework": "^10.0.2",
         "laravel/forge-sdk": "^3.13",
+        "laravel/slack-notification-channel": "^3.2",
         "lorisleiva/laravel-actions": "^2.7",
         "nunomaduro/termwind": "^1.15"
     },