|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Diagnostics.CodeAnalysis;
namespace Aspire.Hosting.Publishing;
/// <summary>
/// Represents a publishing step, which can contain multiple tasks.
/// </summary>
[Experimental("ASPIREPUBLISHERS001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
public interface IPublishingStep : IAsyncDisposable
{
/// <summary>
/// Creates a new task within this step.
/// </summary>
/// <param name="statusText">The initial status text for the task.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The created task.</returns>
Task<IPublishingTask> CreateTaskAsync(string statusText, CancellationToken cancellationToken = default);
/// <summary>
/// Completes the step with the specified completion text and state.
/// </summary>
/// <param name="completionText">The completion text for the step.</param>
/// <param name="completionState">The completion state for the step.</param>
/// <param name="cancellationToken">The cancellation token.</param>
Task CompleteAsync(string completionText, CompletionState completionState = CompletionState.Completed, CancellationToken cancellationToken = default);
}
|