ContinuousIntegration
ConsoleMonster
Provider-native groups, annotations and job summaries with ordinary terminal fallbacks.
Inheritance
- object
- ContinuousIntegration
Methods
public static string AddSummary(string markdown, Action<string>? write = null) #Appends Markdown to GitHub's step summary or uploads a retained Markdown file in Azure. Other hosts only return the Markdown.
Parameters
- markdown string
- The Markdown document.
- write System.Action<string>? = null
- Optional host stdout sink for Azure's upload command.
Returns
string The supplied Markdown, also when no provider summary is available.public static string AddSummary(IWidget widget, ExportOptions? options = null, IFrameExportProvider? provider = null, Action<string>? write = null) #Exports a widget with the existing semantic Markdown provider, then adds it to the job summary.
Parameters
- widget ConsoleMonster.Layout.IWidget
- The table, record, tree or other widget.
- options ConsoleMonster.Export.ExportOptions? = null
- Export sizing and formatting.
- provider ConsoleMonster.Export.IFrameExportProvider? = null
- A Markdown provider from ConsoleMonster.Markdown, or null to use a registered provider.
- write System.Action<string>? = null
- Optional host stdout sink.
Returns
string The exported Markdown.public static void Annotate(AnnotationLevel level, string message, string? title = null, string? file = null, int? line = null, int? column = null, Action<string>? write = null) #Writes an annotation, or a styled status line when the provider has no annotation API.
Parameters
- level ConsoleMonster.AnnotationLevel
- Error, Warning or Notice.
- message string
- Literal message, escaped for the selected protocol.
- title string? = null
- Optional annotation title (prepended to the message outside GitHub).
- file string? = null
- Optional source file. Files within the provider workspace become checkout-relative paths with forward slashes; outside paths stay as supplied. Terminal labels are relative to the current directory.
- line int? = null
- One-based source line, or null.
- column int? = null
- One-based source column, or null.
- write System.Action<string>? = null
- Optional host stdout sink; receives complete unstyled command lines.
public static IDisposable Group(string title, Action<string>? write = null) #Opens a collapsible provider group, or writes a muted heading in an ordinary terminal. Dispose closes it, including during exception unwinding.
Parameters
- title string
- Literal heading.
- write System.Action<string>? = null
- Optional host stdout sink, also retained for the closing marker.
Returns
IDisposable The idempotent group scope. Nest groups and dispose them in reverse order.public static IDisposable UseProvider(ContinuousIntegrationProvider provider) #Overrides detection for this async flow until disposed; None explicitly disables provider output.
Parameters
- provider ConsoleMonster.ContinuousIntegrationProvider
- The protocol to use.
Returns
IDisposable A scope that restores the preceding choice.Inherited Methods
Properties
public static ContinuousIntegrationProvider Provider { get; } #The scoped override, CONSOLEMONSTER_CI, or the provider's own environment variable, in that order.