Merge pull request #113 from SanjulaGanepola/feature/skip-status

Add support for skipped job and step status

package.json

@@ -765,6 +765,14 @@
           "light": "#89d185"
         }
       },
+      {
+        "id": "GitHubLocalActions.red",
+        "description": "Color for red in the GitHub Local Actions extension",
+        "defaults": {
+          "dark": "#f48771",
+          "light": "#f48771"
+        }
+      },
       {
         "id": "GitHubLocalActions.yellow",
         "description": "Color for yellow in the GitHub Local Actions extension",
@@ -773,6 +781,14 @@
           "light": "#cca700"
         }
       },
+      {
+        "id": "GitHubLocalActions.grey",
+        "description": "Color for grey in the GitHub Local Actions extension",
+        "defaults": {
+          "dark": "#808080",
+          "light": "#808080"
+        }
+      },
       {
         "id": "GitHubLocalActions.purple",
         "description": "Color for purple in the GitHub Local Actions extension",
@@ -780,14 +796,6 @@
           "dark": "#d6bcfa",
           "light": "#d6bcfa"
         }
-      },
-      {
-        "id": "GitHubLocalActions.red",
-        "description": "Color for red in the GitHub Local Actions extension",
-        "defaults": {
-          "dark": "#f48771",
-          "light": "#f48771"
-        }
       }
     ]
   },

src/act.ts

@@ -375,7 +375,7 @@ export class Act {
             ...settings.options.map(option => option.path ? `--${option.name} ${option.path}` : `--${option.name}`)
         ];
 
-        const command = `${actCommand} ${Option.Json} ${commandArgs.options.join(' ')} ${userOptions.join(' ')}`;
+        const command = `${actCommand} ${Option.Json} ${Option.Verbose} ${commandArgs.options.join(' ')} ${userOptions.join(' ')}`;
         const displayCommand = `${actCommand} ${commandArgs.options.join(' ')} ${userOptions.join(' ')}`;
 
         // Execute task
@@ -442,12 +442,27 @@ export class Act {
                             let message: string;
                             try {
                                 const parsedMessage = JSON.parse(line);
+
+                                let updateHistory: boolean = true;
+                                // 1. Filter all debug and trace messages except for skipped jobs and steps
+                                // 2. Filter all skipped pre and post stage steps
+                                if ((parsedMessage.level && ['debug', 'trace'].includes(parsedMessage.level) && parsedMessage.jobResult !== 'skipped' && parsedMessage.stepResult !== 'skipped') ||
+                                    (parsedMessage.stepResult === 'skipped' && parsedMessage.stage !== 'Main')) {
+                                    if (userOptions.includes(Option.Verbose)) {
+                                        updateHistory = false;
+                                    } else {
+                                        continue;
+                                    }
+                                }
+
+                                // Prepend job name to message
                                 if (typeof parsedMessage.msg === 'string') {
                                     message = `${parsedMessage.job ? `[${parsedMessage.job}] ` : ``}${parsedMessage.msg}`;
                                 } else {
                                     message = line;
                                 }
 
+                                if (updateHistory) {
                                     // Update job status in workspace history
                                     if (parsedMessage.jobID) {
                                         let jobName: string = parsedMessage.jobID;
@@ -516,18 +531,19 @@ export class Act {
 
                                             if (parsedMessage.stepResult) {
                                                 this.historyManager.workspaceHistory[commandArgs.path][historyIndex].jobs![jobIndex].steps![stepIndex].status =
-                                                parsedMessage.stepResult === 'success' ? HistoryStatus.Success : HistoryStatus.Failed;
+                                                    HistoryManager.stepResultToHistoryStatus(parsedMessage.stepResult);
                                                 this.historyManager.workspaceHistory[commandArgs.path][historyIndex].jobs![jobIndex].steps![stepIndex].date.end = dateString;
                                             }
                                         }
 
                                         if (parsedMessage.jobResult) {
                                             this.historyManager.workspaceHistory[commandArgs.path][historyIndex].jobs![jobIndex].status =
-                                            parsedMessage.jobResult === 'success' ? HistoryStatus.Success : HistoryStatus.Failed;
+                                                HistoryManager.stepResultToHistoryStatus(parsedMessage.jobResult);
                                             this.historyManager.workspaceHistory[commandArgs.path][historyIndex].jobs![jobIndex].date.end =
                                                 dateString;
                                         }
                                     }
+                                }
                             } catch (error: any) {
                                 message = line;
                             }

src/historyManager.ts

@@ -42,6 +42,7 @@ export enum HistoryStatus {
     Running = 'Running',
     Success = 'Success',
     Failed = 'Failed',
+    Skipped = 'Skipped',
     Cancelled = 'Cancelled',
     Unknown = 'Unknown'
 }
@@ -132,8 +133,21 @@ export class HistoryManager {
                 return new ThemeIcon('error', new ThemeColor('GitHubLocalActions.red'));
             case HistoryStatus.Cancelled:
                 return new ThemeIcon('circle-slash', new ThemeColor('GitHubLocalActions.yellow'));
+            case HistoryStatus.Skipped:
+                return new ThemeIcon('issues', new ThemeColor('GitHubLocalActions.grey'));
             case HistoryStatus.Unknown:
                 return new ThemeIcon('question', new ThemeColor('GitHubLocalActions.purple'));
         }
     }
+
+    static stepResultToHistoryStatus(stepResult: string) {
+        switch (stepResult) {
+            case 'success':
+                return HistoryStatus.Success;
+            case 'skipped':
+                return HistoryStatus.Skipped;
+            default:
+                return HistoryStatus.Failed;
+        }
+    }
 }

src/views/history/job.ts

@@ -9,7 +9,7 @@ export default class JobTreeItem extends TreeItem implements GithubLocalActionsT
     job: Job;
 
     constructor(public workspaceFolder: WorkspaceFolder, job: Job) {
-        super(job.name, TreeItemCollapsibleState.Expanded);
+        super(job.name, job.status === HistoryStatus.Skipped ? TreeItemCollapsibleState.None : TreeItemCollapsibleState.Expanded);
         this.job = job;
 
         let endTime: string | undefined;