Class DevOpsCheckoutStep
- Namespace
- Invex.Atom.Module.DevOpsWorkflows.Steps
- Assembly
- Invex.Atom.Module.DevOpsWorkflows.dll
Represents a workflow option for configuring the checkout step in Azure DevOps Pipelines.
public sealed record DevOpsCheckoutStep : CheckoutStep, IDevOpsAdditionalStepOption, IAdditionalStepOption, IBuildOption
- Inheritance
-
objectDevOpsCheckoutStep
- Implements
- Inherited Members
Constructors
DevOpsCheckoutStep()
public DevOpsCheckoutStep()
Properties
Clean
Whether to clean the repository before checkout.
public Template? Clean { get; init; }
Property Value
- Template
Condition
Evaluate this condition expression to determine whether to run this task.
public BoolExpr? Condition { get; init; }
Property Value
- BoolExpr
ContinueOnError
Continue running even on failure?
public Template? ContinueOnError { get; init; }
Property Value
- Template
DisplayName
Human-readable name for the task.
public Template? DisplayName { get; init; }
Property Value
- Template
Env
Variables to map into the process's environment.
public IReadOnlyDictionary<string, Template>? Env { get; init; }
Property Value
- IReadOnlyDictionary<string, Template>
FetchDepth
Number of commits to fetch (depth). 0 indicates all history.
public Template? FetchDepth { get; init; }
Property Value
- Template
Lfs
Whether to download Git-LFS files.
public Template? Lfs { get; init; }
Property Value
- Template
Name
ID of the step.
public Template? Name { get; init; }
Property Value
- Template
Path
Path to check out source code, relative to $(Agent.BuildDirectory).
public Template? Path { get; init; }
Property Value
- Template
PersistCredentials
Persist credentials for later use by the Git command-line tool.
public Template? PersistCredentials { get; init; }
Property Value
- Template
Repository
Repository to check out. Valid values: "self" | "none" or repository resource name.
public Template Repository { get; init; }
Property Value
- Template
RetryCountOnTaskFailure
Number of retries if the task fails.
public Template? RetryCountOnTaskFailure { get; init; }
Property Value
- Template
Submodules
Whether to checkout submodules.
public Template? Submodules { get; init; }
Property Value
- Template
Target
Environment in which to run this task.
public StepTarget? Target { get; init; }
Property Value
- StepTarget
TaskEnabled
Run this task when the job runs? Written as the task's enabled property. Not to be confused with
Enabled, which controls whether a checkout step is added at all.
public Template? TaskEnabled { get; init; }
Property Value
- Template
TimeoutInMinutes
Time to wait for this task to complete before the server kills it.
public Template? TimeoutInMinutes { get; init; }
Property Value
- Template
Methods
Build()
public Step Build()
Returns
- Step