Skip to content

Commit

Permalink
update as per review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mw-kapilg committed Aug 21, 2024
1 parent 65e8022 commit 2c9e673
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 24 deletions.
32 changes: 15 additions & 17 deletions plugins/+ciplugins/+github/BuildSummaryPlugin.m
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
% Copyright 2024 The MathWorks, Inc.

properties
taskDetails = {};
TaskDetails = {};
end

methods (Access=protected)
Expand All @@ -15,35 +15,33 @@ function runTaskGraph(plugin, pluginData)
warning("ciplugins:github:BuildSummaryPlugin:UnableToOpenFile","Unable to open a file required to create the MATLAB build summary table: %s", msg);
else
closeFile = onCleanup(@()fclose(fID));
s = jsonencode(plugin.taskDetails);
s = jsonencode(plugin.TaskDetails);
fprintf(fID, "%s",s);
end
end

function runTask(plugin, pluginData)
runTask@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);

taskDetail = plugin.getCommonTaskData(pluginData);
plugin.taskDetails = [plugin.taskDetails, taskDetail];
taskDetail = getCommonTaskData(pluginData);
plugin.TaskDetails = [plugin.TaskDetails, taskDetail];
end

function skipTask(plugin, pluginData)
skipTask@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);

taskDetail = plugin.getCommonTaskData(pluginData);
taskDetail = getCommonTaskData(pluginData);
taskDetail.skipReason = pluginData.SkipReason;
plugin.taskDetails = [plugin.taskDetails, taskDetail];
end
end

methods(Static, Access=private)
function taskDetail = getCommonTaskData(pluginData)
taskDetail = struct();
taskDetail.name = pluginData.TaskResults.Name;
taskDetail.description = pluginData.TaskGraph.Tasks.Description;
taskDetail.failed = pluginData.TaskResults.Failed;
taskDetail.skipped = pluginData.TaskResults.Skipped;
taskDetail.duration = string(pluginData.TaskResults.Duration);
plugin.TaskDetails = [plugin.TaskDetails, taskDetail];
end
end
end

function taskDetail = getCommonTaskData(pluginData)
taskDetail = struct();
taskDetail.name = pluginData.TaskResults.Name;
taskDetail.description = pluginData.TaskGraph.Tasks.Description;
taskDetail.failed = pluginData.TaskResults.Failed;
taskDetail.skipped = pluginData.TaskResults.Skipped;
taskDetail.duration = string(pluginData.TaskResults.Duration);
end
14 changes: 7 additions & 7 deletions src/buildSummary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ export function writeSummary(taskSummaryTableRows: string[][]) {
export function getSummaryRows(buildSummary: string): any[] {
const rows = JSON.parse(buildSummary).map((t: any) => {
if (t.failed) {
return [t.name, '🔴 Failed', t.description, t.duration.toString()];
return [t.name, '🔴 Failed', t.description, t.duration];
} else if (t.skipped) {
return [t.name, '🔵 Skipped' + ' (' + interpretSkipReason(t.skipReason) + ')', t.description, t.duration.toString()];
return [t.name, '🔵 Skipped' + ' (' + interpretSkipReason(t.skipReason) + ')', t.description, t.duration];
} else {
return [t.name, '🟢 Success', t.description, t.duration.toString()];
return [t.name, '🟢 Success', t.description, t.duration];
}
});
return rows;
Expand All @@ -29,13 +29,13 @@ export function getSummaryRows(buildSummary: string): any[] {
export function interpretSkipReason(skipReason: string){
switch(skipReason) {
case "UpToDate":
return "Up-To-Date";
return "up-to-date";
case "UserSpecified":
return "User Specified";
return "user specified";
case "UserRequested":
return "User Requested";
return "user requested";
case "DependencyFailed":
return "Dependency Failed";
return "dependency failed";
default:
return skipReason;
}
Expand Down

0 comments on commit 2c9e673

Please sign in to comment.