From 8d636f88101fca9f1101f5fa06ce9eb8255c0857 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Wei=C3=9Fe?= <dw@edgeless.systems>
Date: Wed, 16 Oct 2024 10:29:24 +0200
Subject: [PATCH] Add instructions on how to update notify_teams assignees
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Daniel Weiße <dw@edgeless.systems>
---
 .github/actions/notify_teams/README.md        | 27 +++++++++++++++++++
 .github/actions/notify_teams/action.yml       |  2 +-
 .../notify_teams}/teams_payload_template.json |  0
 3 files changed, 28 insertions(+), 1 deletion(-)
 create mode 100644 .github/actions/notify_teams/README.md
 rename .github/{ => actions/notify_teams}/teams_payload_template.json (100%)

diff --git a/.github/actions/notify_teams/README.md b/.github/actions/notify_teams/README.md
new file mode 100644
index 000000000..5fb6d724b
--- /dev/null
+++ b/.github/actions/notify_teams/README.md
@@ -0,0 +1,27 @@
+# notify Teams action
+
+This action is used to send a message to our Teams channel in case of a failure in the CI/CD pipeline.
+The action will automatically choose an engineer to assign to the issue and tag them in the message.
+
+Engineers are identified by their GitHub username and bound to a Microsoft Teams ID in `.attachments[0].content.msteams.entities`.
+To add a new engineer, add a new entry to the entity list in the format:
+
+```json
+{
+  "type": "mention",
+  "text": "${github_username}",
+  "mentioned": {
+    "id": "${msteams_id}",
+    "name": "${name}"
+  }
+}
+```
+
+Where `${github_username}` is the GitHub username of the engineer, `${msteams_id}` is the Microsoft Teams ID of the engineer, and `${name}` is the name of the engineer.
+To find the Microsoft Teams ID use the following command:
+
+```bash
+az ad user show --id ${email} --query id
+```
+
+Where `${email}` is the email address of the engineer.
diff --git a/.github/actions/notify_teams/action.yml b/.github/actions/notify_teams/action.yml
index 956a3a889..e94a266a9 100644
--- a/.github/actions/notify_teams/action.yml
+++ b/.github/actions/notify_teams/action.yml
@@ -25,7 +25,7 @@ runs:
       continue-on-error: true
       shell: bash
       run: |
-        cp .github/teams_payload_template.json teams_payload.json
+        cp .github/actions/notify_teams/teams_payload_template.json teams_payload.json
 
         # Add workflow name to the notification
         yq -oj -iP '.attachments[0].content.body[0].columns[1].items[0].text = "${{ inputs.title }}"' teams_payload.json
diff --git a/.github/teams_payload_template.json b/.github/actions/notify_teams/teams_payload_template.json
similarity index 100%
rename from .github/teams_payload_template.json
rename to .github/actions/notify_teams/teams_payload_template.json