GitLabCIEngine Class

Summary

ICakeEngine implementation for GitLab CI.
Assembly
Cake.GitLabCI.Module.dll
Namespace
Cake.GitLabCI.Module
Interfaces
  • ICakeEngine
Base Types
graph BT Type-->Base0["CakeEngineBase"] click Base0 "/api/Cake.Module.Shared/CakeEngineBase" Base0-->Base1["Object"] Type-.->Interface0["ICakeEngine"] Type["GitLabCIEngine"] class Type type-node

Syntax

public sealed class GitLabCIEngine : CakeEngineBase, ICakeEngine

Remarks

This engine emits additional console output to make GitLab CI render the output of the indiviudal Cake tasks as collapsible sections (see Custom collapsible sections (GitLab Docs)).

Constructors

Name Summary
GitLabCIEngine(ICakeDataService, ICakeLog, IConsole) Initializes a new instance of the GitLabCIEngine class.

Events

Name Type Summary
AfterSetup EventHandler<AfterSetupEventArgs>
Raised at the end of setup before any tasks are run.
Inherited from CakeEngineBase
AfterTaskSetup EventHandler<AfterTaskSetupEventArgs>
Raised at the end of task setup before each task is run.
Inherited from CakeEngineBase
AfterTaskTeardown EventHandler<AfterTaskTeardownEventArgs>
Raised at the end of task teardown after each task has been run.
Inherited from CakeEngineBase
AfterTeardown EventHandler<AfterTeardownEventArgs>
Raised at the end of teardown after all other tasks have been run.
Inherited from CakeEngineBase
BeforeSetup EventHandler<BeforeSetupEventArgs>
Raised at the start of setup before any tasks are run.
Inherited from CakeEngineBase
BeforeTaskSetup EventHandler<BeforeTaskSetupEventArgs>
Raised at the start of task setup before each task is run.
Inherited from CakeEngineBase
BeforeTaskTeardown EventHandler<BeforeTaskTeardownEventArgs>
Raised at the start of task teardown after each task has been run.
Inherited from CakeEngineBase
BeforeTeardown EventHandler<BeforeTeardownEventArgs>
Raised at the start of teardown after all other tasks have been run.
Inherited from CakeEngineBase

Fields

Name Constant Value Summary
_engine
Gets the wrapped ICakeEngine.
Inherited from CakeEngineBase

Properties

Name Value Summary
Tasks IReadOnlyList<ICakeTaskInfo>
Gets all registered tasks.
Inherited from CakeEngineBase

Methods

Name Value Summary
RegisterSetupAction(Action<ICakeContext>) void
Allows registration of an action that's executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed.
Inherited from CakeEngineBase
RegisterSetupAction(Action<ISetupContext>) void
Inherited from CakeEngineBase
RegisterSetupAction<TData>(Func<ISetupContext, TData>) void
Inherited from CakeEngineBase
RegisterTask(string) CakeTaskBuilder
Registers a new task.
Inherited from CakeEngineBase
RegisterTaskSetupAction(Action<ITaskSetupContext>) void
Allows registration of an action that's executed before each task is run. If the task setup fails, the task will not be executed but the task's teardown will be performed.
Inherited from CakeEngineBase
RegisterTaskSetupAction<TData>(Action<ITaskSetupContext, TData>) void
Inherited from CakeEngineBase
RegisterTaskTeardownAction(Action<ITaskTeardownContext>) void
Allows registration of an action that's executed after each task has been run. If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
Inherited from CakeEngineBase
RegisterTaskTeardownAction<TData>(Action<ITaskTeardownContext, TData>) void
Inherited from CakeEngineBase
RegisterTeardownAction(Action<ITeardownContext>) void
Allows registration of an action that's executed after all other tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
Inherited from CakeEngineBase
RegisterTeardownAction<TData>(Action<ITeardownContext, TData>) void
Inherited from CakeEngineBase
RunTargetAsync(ICakeContext, IExecutionStrategy, ExecutionSettings) Task<CakeReport>
Runs the specified target using the specified IExecutionStrategy.
Inherited from CakeEngineBase

Extension Methods

Name Value Summary
Dump<GitLabCIEngine>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GitLabCIEngine>(GitLabCIEngine[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GitLabCIEngine>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GitLabCIEngine>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GitLabCIEngine>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GitLabCIEngine>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin