From 713b95cc33d495c966f1f944d72dc69c70bc8c15 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Nicoll?= <stephane.nicoll@broadcom.com>
Date: Tue, 19 Nov 2024 15:14:00 +0100
Subject: [PATCH] Add failure notification

---
 .github/actions/send-notification/action.yml | 39 ++++++++++++++++++++
 .github/workflows/deploy-docs.yml            |  7 ++++
 2 files changed, 46 insertions(+)
 create mode 100644 .github/actions/send-notification/action.yml

diff --git a/.github/actions/send-notification/action.yml b/.github/actions/send-notification/action.yml
new file mode 100644
index 0000000000..b379e67897
--- /dev/null
+++ b/.github/actions/send-notification/action.yml
@@ -0,0 +1,39 @@
+name: Send Notification
+description: 'Sends a Google Chat message as a notification of the job''s outcome'
+inputs:
+  build-scan-url:
+    description: 'URL of the build scan to include in the notification'
+    required: false
+  run-name:
+    description: 'Name of the run to include in the notification'
+    required: false
+    default: ${{ format('{0} {1}', github.ref_name, github.job) }}
+  status:
+    description: 'Status of the job'
+    required: true
+  webhook-url:
+    description: 'Google Chat Webhook URL'
+    required: true
+runs:
+  using: composite
+  steps:
+    - name: Prepare Variables
+      shell: bash
+      run: |
+        echo "BUILD_SCAN=${{ inputs.build-scan-url == '' && ' [build scan unavailable]' || format(' [<{0}|Build Scan>]', inputs.build-scan-url) }}" >> "$GITHUB_ENV"
+        echo "RUN_URL=${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" >> "$GITHUB_ENV"
+    - name: Success Notification
+      if: ${{ inputs.status == 'success' }}
+      shell: bash
+      run: |
+        curl -X POST '${{ inputs.webhook-url }}' -H 'Content-Type: application/json' -d '{ text: "<${{ env.RUN_URL }}|${{ inputs.run-name }}> was successful ${{ env.BUILD_SCAN }}"}' || true
+    - name: Failure Notification
+      if: ${{ inputs.status == 'failure' }}
+      shell: bash
+      run: |
+        curl -X POST '${{ inputs.webhook-url }}' -H 'Content-Type: application/json' -d '{ text: "<users/all> *<${{ env.RUN_URL }}|${{ inputs.run-name }}> failed* ${{ env.BUILD_SCAN }}"}' || true
+    - name: Cancel Notification
+      if: ${{ inputs.status == 'cancelled' }}
+      shell: bash
+      run: |
+        curl -X POST '${{ inputs.webhook-url }}' -H 'Content-Type: application/json' -d '{ text: "<${{ env.RUN_URL }}|${{ inputs.run-name }}> was cancelled"}' || true
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index 78a37fe172..af3ac8de23 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -62,3 +62,10 @@ jobs:
         context-path: /
         cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }}
         cloudflare-cache-token: ${{ secrets.CLOUDFLARE_CACHE_TOKEN }}
+    - name: Send Notification
+      if: failure()
+      uses: ./.github/actions/send-notification
+      with:
+        run-name: ${{ format('{0} | Build and Deploy Docs', github.ref_name) }}
+        status: ${{ job.status }}
+        webhook-url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_URL }}