actions/runner
1
0
Fork 0
mirror of https://github.com/actions/runner.git synced 2025-12-12 05:37:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean Up Composite UI (#610)

Browse Source 
* Remove redundant code (display name is already evaluated in ActionRunner beforehand for each step)

* remove

* Remove nesting information for composite steps.

* put messages in debug logs if composite. if not, put these messages as outputs

* Fix group issue

* Fix end group issue
This commit is contained in:
Ethan Chiu
2020-07-23 09:45:00 -04:00
committed by GitHub
parent e7b0844772
commit 2e50dffb37
3 changed files with 29 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Runner.Worker/ExecutionContext.cs
View File

@@ -60,12 +60,14 @@ namespace GitHub.Runner.Worker
bool EchoOnActionCommand { get; set; } bool EchoOnActionCommand { get; set; }
bool InsideComposite { get; }
ExecutionContext Root { get; } ExecutionContext Root { get; }
// Initialize // Initialize
void InitializeJob(Pipelines.AgentJobRequestMessage message, CancellationToken token); void InitializeJob(Pipelines.AgentJobRequestMessage message, CancellationToken token);
void CancelToken(); void CancelToken();
IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null, IPagingLogger logger = null, CancellationTokenSource cancellationTokenSource = null); IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null, IPagingLogger logger = null, bool insideComposite = false, CancellationTokenSource cancellationTokenSource = null);
// logging // logging
long Write(string tag, string message); long Write(string tag, string message);
@@ -152,6 +154,8 @@ namespace GitHub.Runner.Worker
public bool EchoOnActionCommand { get; set; } public bool EchoOnActionCommand { get; set; }
public bool InsideComposite { get; private set; }
public TaskResult? Result public TaskResult? Result
{ {
get get
@@ -256,7 +260,7 @@ namespace GitHub.Runner.Worker
DictionaryContextData inputsData, DictionaryContextData inputsData,
Dictionary<string, string> envData) Dictionary<string, string> envData)
{ {
step.ExecutionContext = Root.CreateChild(_record.Id, step.DisplayName, _record.Id.ToString("N"), scopeName, step.Action.ContextName, logger: _logger, cancellationTokenSource: CancellationTokenSource.CreateLinkedTokenSource(_cancellationTokenSource.Token)); step.ExecutionContext = Root.CreateChild(_record.Id, step.DisplayName, _record.Id.ToString("N"), scopeName, step.Action.ContextName, logger: _logger, insideComposite: true, cancellationTokenSource: CancellationTokenSource.CreateLinkedTokenSource(_cancellationTokenSource.Token));
step.ExecutionContext.ExpressionValues["inputs"] = inputsData; step.ExecutionContext.ExpressionValues["inputs"] = inputsData;
step.ExecutionContext.ExpressionValues["steps"] = Global.StepsContext.GetScope(step.ExecutionContext.GetFullyQualifiedContextName()); step.ExecutionContext.ExpressionValues["steps"] = Global.StepsContext.GetScope(step.ExecutionContext.GetFullyQualifiedContextName());
@@ -275,7 +279,7 @@ namespace GitHub.Runner.Worker
return step; return step;
} }
public IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null, IPagingLogger logger = null, CancellationTokenSource cancellationTokenSource = null) public IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null, IPagingLogger logger = null, bool insideComposite = false, CancellationTokenSource cancellationTokenSource = null)
{ {
Trace.Entering(); Trace.Entering();
@@ -322,6 +326,8 @@ namespace GitHub.Runner.Worker
child._logger.Setup(_mainTimelineId, recordId); child._logger.Setup(_mainTimelineId, recordId);
} }
child.InsideComposite = insideComposite;
return child; return child;
} }

6
src/Runner.Worker/Handlers/CompositeActionHandler.cs
View File

@@ -215,12 +215,6 @@ namespace GitHub.Runner.Worker.Handlers
private async Task RunStepAsync(IStep step) private async Task RunStepAsync(IStep step)
{ {
// Try to evaluate the display name
if (step is IActionRunner actionRunner && actionRunner.Stage == ActionRunStage.Main)
{
actionRunner.TryEvaluateDisplayName(step.ExecutionContext.ExpressionValues, step.ExecutionContext);
}
// Start the step. // Start the step.
Trace.Info("Starting the step."); Trace.Info("Starting the step.");
step.ExecutionContext.Debug($"Starting: {step.DisplayName}"); step.ExecutionContext.Debug($"Starting: {step.DisplayName}");

27
src/Runner.Worker/Handlers/ScriptHandler.cs
View File

@@ -23,6 +23,19 @@ namespace GitHub.Runner.Worker.Handlers
public override void PrintActionDetails(ActionRunStage stage) public override void PrintActionDetails(ActionRunStage stage)
{ {
// We don't want to display the internal workings if composite (similar/equivalent information can be found in debug)
void writeDetails(string message)
{
if (ExecutionContext.InsideComposite)
{
ExecutionContext.Debug(message);
}
else
{
ExecutionContext.Output(message);
}
}
if (stage == ActionRunStage.Post) if (stage == ActionRunStage.Post)
{ {
throw new NotSupportedException("Script action should not have 'Post' job action."); throw new NotSupportedException("Script action should not have 'Post' job action.");
@@ -39,7 +52,7 @@ namespace GitHub.Runner.Worker.Handlers
firstLine = firstLine.Substring(0, firstNewLine); firstLine = firstLine.Substring(0, firstNewLine);
} }
ExecutionContext.Output($"##[group]Run {firstLine}"); writeDetails(ExecutionContext.InsideComposite ? $"Run {firstLine}" : $"##[group]Run {firstLine}");
} }
else else
{ {
@@ -50,7 +63,7 @@ namespace GitHub.Runner.Worker.Handlers
foreach (var line in multiLines) foreach (var line in multiLines)
{ {
// Bright Cyan color // Bright Cyan color
ExecutionContext.Output($"\x1b[36;1m{line}\x1b[0m"); writeDetails($"\x1b[36;1m{line}\x1b[0m");
} }
string argFormat; string argFormat;
@@ -109,23 +122,23 @@ namespace GitHub.Runner.Worker.Handlers
if (!string.IsNullOrEmpty(shellCommandPath)) if (!string.IsNullOrEmpty(shellCommandPath))
{ {
ExecutionContext.Output($"shell: {shellCommandPath} {argFormat}"); writeDetails($"shell: {shellCommandPath} {argFormat}");
} }
else else
{ {
ExecutionContext.Output($"shell: {shellCommand} {argFormat}"); writeDetails($"shell: {shellCommand} {argFormat}");
} }
if (this.Environment?.Count > 0) if (this.Environment?.Count > 0)
{ {
ExecutionContext.Output("env:"); writeDetails("env:");
foreach (var env in this.Environment) foreach (var env in this.Environment)
{ {
ExecutionContext.Output($" {env.Key}: {env.Value}"); writeDetails($" {env.Key}: {env.Value}");
} }
} }
ExecutionContext.Output("##[endgroup]"); writeDetails(ExecutionContext.InsideComposite ? "" : "##[endgroup]");
} }
public async Task RunAsync(ActionRunStage stage) public async Task RunAsync(ActionRunStage stage)