Repository navigation
Script execution does not always show a report summary #4475
Description
Prerequisites
- I have written a descriptive issue title
- I have searched issues to ensure it has not already been reported
Cake runner
Cake .NET Tool
Cake version
5.0.0
Operating system
Windows
Operating system architecture
x64
CI Server
GitHub Actions
What are you seeing?
When you run a script that doesn't have any build issues, you get a nice summary of the output, including what was run, what was skipped, and how long each task took.
However, when you run a script that doesn't run to completion, due to an error occuring, the nice summary is not show, and as a result, it is not immediately clear what task has failed.
What is expected?
Regardless of whether the Cake script is successful, or if it contains an error, I always want to see the report summary, so I can immediately see what was executed, how long it took, what was skipped, etc.
Steps to Reproduce
- Run the following script and see the report summary shown
var target = Argument("target", "Test");
var configuration = Argument("configuration", "Release");
//////////////////////////////////////////////////////////////////////
// TASKS
//////////////////////////////////////////////////////////////////////
Task("Clean")
.WithCriteria(c => HasArgument("rebuild"), "Just because!")
.Does(() =>
{
Information("Running Clean Task");
});
Task("Build")
.IsDependentOn("Clean")
.Does(() =>
{
//Information("Running build task");
});
Task("Test")
.IsDependentOn("Build")
.Does(() =>
{
Information("Running Test Task");
});
//////////////////////////////////////////////////////////////////////
// EXECUTION
//////////////////////////////////////////////////////////////////////
RunTarget(target);
- Run the following script and see the report summary not being shown
var target = Argument("target", "Test");
var configuration = Argument("configuration", "Release");
//////////////////////////////////////////////////////////////////////
// TASKS
//////////////////////////////////////////////////////////////////////
Task("Clean")
.WithCriteria(c => HasArgument("rebuild"), "Just because!")
.Does(() =>
{
Information("Running Clean Task");
});
Task("Build")
.IsDependentOn("Clean")
.Does(() =>
{
//Information("Running build task");
});
Task("Test")
.IsDependentOn("Build")
.Does(() =>
{
throw new Exception("boom");
});
//////////////////////////////////////////////////////////////////////
// EXECUTION
//////////////////////////////////////////////////////////////////////
RunTarget(target);
Output log
NOTE: The following scripts outputs were created using the following setting in the cake.config file:
UseSpectreConsoleForConsoleOutput=true
When running the first script:
==================================================================================================
Build
==================================================================================================
==================================================================================================
Test
==================================================================================================
Running Test Task
Task Duration Skip Reason
────────────────────────────────────────────────────────────────────────────────────────────────────
Clean Skipped Just because!
Build 00:00:00.0535861
Test 00:00:00.0024934
────────────────────────────────────────────────────────────────────────────────────────────────────
Total: 00:00:00.0560795
And the screenshot version:
When running the second script:
==================================================================================================
Build
==================================================================================================
==================================================================================================
Test
==================================================================================================
An error occurred when executing task 'Test'.
Error: boom`
And then the screenshot version:
Activity
gep13 commentedon May 24, 2025
My suggestion would be instead to introduce a new column, which included the ExecutionStatus for the task, and show all the steps that completed up to the failing task.
A suggestion for how the output would look like would be the following:
Thoughts?
gep13 commentedon May 24, 2025
I notice now that I have lost the message from the exception that was thrown, so I will need to get that back, but otherwise, this is what I would like to move forward with.
devlead commentedon May 24, 2025
Sounds like a good idea to me,
[-]Script exectuion does not always show a report summary[/-][+]Script execution does not always show a report summary[/+](cake-build#4475) Always show task execution summary
(cake-build#4475) Always show task execution summary
devlead commentedon Jun 5, 2025
Fixed by #4486
github-actions commentedon Oct 4, 2025
🎉 This issue has been resolved in version v5.1.0 🎉
The release is available on:
Your GitReleaseManager bot 📦🚀
Bump cake.tool from 4.0.0 to 6.3.0 (#39809)