add status override (#104)

README.md

@@ -6,6 +6,7 @@ This is a fork of https://github.com/toko-bifrost/ms-teams-deploy-card with the
 * Fix wrong input names in readme
 * Write the branch instead of the commit hash in the Teams card.
 * Add option to ignore failures caused by cancelling the workflow.
+* Properly report matrix job status (see [Note when using matrix jobs](#note-matrix-jobs)).
 
 ### Screenshots of the modified cards:
 
@@ -71,6 +72,16 @@ jobs:
           webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI }}
 ```
 
+#### <a name="note-matrix-jobs"></a>Note when using matrix jobs
+The GitHub API makes it difficult to identify a specific matrix job from an action.
+To properly pass the matrix job status to action, add the following step to the end of your workflow file:
+
+```yaml
+      - run: echo "ms_teams_notification_job_status=${{ job.status }}" >> "$GITHUB_ENV"
+        if: always()
+```
+The notification action will pick up the environment variable and use it to determine the status of the matrix job.
+
 ### Configurations
 
 #### Main Configurations

src/utils.ts

@@ -135,9 +135,16 @@ export async function getWorkflowRunStatus() {
   const startTime = moment(jobStartDate, moment.ISO_8601);
   const endTime = moment(lastStep?.completed_at, moment.ISO_8601);
 
+  let conclusion;
+  if (process.env.ms_teams_notification_job_status) {
+    conclusion = process.env.ms_teams_notification_job_status;
+  } else {
+    conclusion = lastStep?.conclusion;
+  }
+
   return {
     elapsedSeconds: endTime.diff(startTime, "seconds"),
-    conclusion: lastStep?.conclusion,
+    conclusion: conclusion
   };
 }