AzurePipelinesAttributeBase Class

Definition

C#

public abstract class AzurePipelinesAttributeBase : AzurePipelinesAttribute, IConfigurationGenerator

Inheritance object → Attribute → Nuke.Common.CI.ConfigurationAttributeBase → Nuke.Common.CI.ChainedConfigurationAttributeBase → Nuke.Common.CI.AzurePipelines.AzurePipelinesAttribute

Implements Nuke.Common.CI.IConfigurationGenerator

Constructors

AzurePipelinesAttributeBase(string?)

C#

public AzurePipelinesAttributeBase(string? suffix = null)

Parameters

suffix string

Fields

DefaultImage

C#

public const AzurePipelinesImage DefaultImage = WindowsLatest

Properties

NugetConfigPath

Gets or sets the NuGet config path to use.

C#

[Parameter("The NuGet config path to use")]
public string? NugetConfigPath { get; set; }

Image

Gets or sets the Azure pipelines virtual machine image, if valid.

C#

public AzurePipelinesImage Image { get; set; }

Remarks

This property is a duplicate of what the base Nuke class stores in a private field. It may be invalid in case the ImageName property is set.

ImageName

Gets or sets the Azure pipelines virtual machine image name, if valid.

C#

[Parameter("The Azure pipelines virtual machine image name, if valid.")]
public string? ImageName { get; set; }

Remarks

This property may be null in case the Image property is set.

PoolName

Gets or sets the Azure pipelines virtual machine pool name, if any.

C#

[Parameter("The Azure pipelines virtual machine pool name, if any.")]
public string? PoolName { get; set; }

Remarks

If not set, Azure will default to use the Microsoft-hosted virtual machine pool.

BuildTimeoutInMinutes

Gets or sets the build job timeout, in minutes, if any.

C#

[Parameter("The build job timeout, in minutes, if any.")]
public uint BuildTimeoutInMinutes { get; set; }

Remarks

Note this includes all steps in the build stage, but not any deployment jobs/stages.

NukeBuildDirectory

Gets or sets the directory within the repo containing the Nuke build scripts.

C#

[Parameter("The directory within the repo containing the Nuke build scripts")]
public string? NukeBuildDirectory { get; set; }

Remarks

If null, this defaults to the root directory.

NukeToolPackageName

Gets or sets the package ID of the Nuke tool to install, if any.

C#

[Parameter("The package ID of the Nuke tool to install, if any.")]
public string? NukeToolPackageName { get; set; }

DotNetSDKs

Gets or sets the .NET SDKs to install before running the build.

C#

[Parameter("The .NET SDKs to install before running the build.")]
public string[] DotNetSDKs { get; set; }

NuGetTimeoutInSeconds

Gets or sets the NuGet authentication and request timeouts, in seconds, if any.

C#

[Parameter("The NuGet authentication and request timeouts, in seconds, if any")]
public uint? NuGetTimeoutInSeconds { get; set; }

BuildCmdPath

C#

protected override string BuildCmdPath { get; }

Methods

GetConfiguration(IReadOnlyCollection)

C#

public override AzurePipelinesConfigurationExt GetConfiguration(IReadOnlyCollection<ExecutableTarget> relevantTargets)

Parameters

relevantTargets IReadOnlyCollection<ExecutableTarget>

Returns

AzurePipelinesConfigurationExt

GetPipelines()

C#

protected virtual IEnumerable<Pipeline> GetPipelines()

Returns

IEnumerable<Pipeline>

GetRepositories()

C#

protected virtual IEnumerable<Repository> GetRepositories()

Returns

IEnumerable<Repository>

CreateDeploymentStages()

C#

protected virtual IEnumerable<AzurePipelinesStageExt> CreateDeploymentStages()

Returns

IEnumerable<AzurePipelinesStageExt>

GetStage(string, IReadOnlyCollection)

C#

protected virtual AzurePipelinesStageExt GetStage(string name, IReadOnlyCollection<ExecutableTarget> relevantTargets)

Parameters

name string

relevantTargets IReadOnlyCollection<ExecutableTarget>

Returns

AzurePipelinesStageExt

MergeStepsToJob(AzurePipelinesJob[])

C#

protected virtual AzurePipelinesJobExt MergeStepsToJob(AzurePipelinesJob[] jobs)

Parameters

jobs Nuke.Common.CI.AzurePipelines.Configuration.AzurePipelinesJob[]

Returns

AzurePipelinesJobExt

MergeSteps(AzurePipelinesJob[])

C#

protected virtual IEnumerable<AzurePipelinesStep> MergeSteps(AzurePipelinesJob[] jobs)

Parameters

jobs Nuke.Common.CI.AzurePipelines.Configuration.AzurePipelinesJob[]

Returns

IEnumerable<AzurePipelinesStep>

CreateSetupSteps()

C#

protected virtual IEnumerable<AzurePipelinesStep> CreateSetupSteps()

Returns

IEnumerable<AzurePipelinesStep>

GetSteps(ExecutableTarget, IReadOnlyCollection, AzurePipelinesImage)

C#

protected override IEnumerable<AzurePipelinesStep> GetSteps(ExecutableTarget executableTarget, IReadOnlyCollection<ExecutableTarget> relevantTargets, AzurePipelinesImage image)

Parameters

executableTarget Nuke.Common.Execution.ExecutableTarget

relevantTargets IReadOnlyCollection<ExecutableTarget>

image Nuke.Common.CI.AzurePipelines.AzurePipelinesImage

Returns

IEnumerable<AzurePipelinesStep>