AzurePipelinesAttribute Class

Definition

C#

public class AzurePipelinesAttribute : AzurePipelinesAttributeBase, IConfigurationGenerator

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

Implements Nuke.Common.CI.IConfigurationGenerator

Constructors

AzurePipelinesAttribute(string?, bool)

C#

public AzurePipelinesAttribute(string? suffix = null, bool disableDeployment = false)

Parameters

suffix string

disableDeployment bool

Properties

RelevantTargetNames

C#

public override IEnumerable<string> RelevantTargetNames { get; }

DeployFromBranch

Gets or sets the branch to deploy from.

C#

[Parameter("The branch to deploy from.")]
public string? DeployFromBranch { get; set; }

Remarks

If null or empty, deployment stages will not run. If ”-” which is an invalid Git branch, deploy from the first trigger branch or “main” by default.

PrereleaseBranches

Gets or sets the prerelease branches to deploy from.

C#

[Parameter("The branches to deploy prelease artifacts from.")]
public string? PrereleaseBranches { get; set; }

Remarks

If null or empty, prerelease deployment stages will not run.

DeploymentStageTemplate

Gets or sets the path for an optional custom deployment stage YAML template.

C#

[Parameter("The path for an optional custom deployment stage YAML template")]
public string? DeploymentStageTemplate { get; set; }

Remarks

If this is set, it will replace the default NuGet deployment stages.

DeploymentModel

Gets or sets the deployment model.

C#

[Parameter("The deployment model (StudiosQualityTech, StudiosQualityTechViewPromotion, XboxStudiosQuality, or ArtifactsOnly)")]
public AzurePipelinesDeploymentModel DeploymentModel { get; set; }

DisableDeployment

Gets or sets a value indicating whether to disable deployment.

C#

[Parameter("Whether to disable deployment")]
public bool DisableDeployment { get; set; }

DeployFromOrTriggerBranch

Gets the name of the branch to deploy from, or else the first trigger branch (main) if left unspecified.

C#

protected string? DeployFromOrTriggerBranch { get; }

Methods

CreateDeploymentStages()

C#

protected override IEnumerable<AzurePipelinesStageExt> CreateDeploymentStages()

Returns

IEnumerable<AzurePipelinesStageExt>

CreateDefaultDeploymentStages()

C#

protected IEnumerable<AzurePipelinesStageExt> CreateDefaultDeploymentStages()

Returns

IEnumerable<AzurePipelinesStageExt>

CreateDeploymentStage()

C#

protected virtual AzurePipelinesStageExt? CreateDeploymentStage()

Returns

AzurePipelinesStageExt

MergeSteps(AzurePipelinesJob[])

C#

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

Parameters

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

Returns

IEnumerable<AzurePipelinesStep>