Class AzurePipelinesAttribute

Inheritance
object
Attribute
ConfigurationAttributeBase
ChainedConfigurationAttributeBase
AzurePipelinesAttribute
AzurePipelinesAttributeBase
AzurePipelinesAttribute
AutoUpdateAzurePipelinesAttribute
Implements
IConfigurationGenerator
Inherited Members
AzurePipelinesAttribute.GetVcsPushTrigger()
AzurePipelinesAttribute.GetVcsPullRequestTrigger()
AzurePipelinesAttribute.GetImports()
AzurePipelinesAttribute.IdPostfix
AzurePipelinesAttribute.HostType
AzurePipelinesAttribute.ConfigurationFile
AzurePipelinesAttribute.GeneratedFiles
AzurePipelinesAttribute.ConfigurationDirectory
AzurePipelinesAttribute.InvokedTargets
AzurePipelinesAttribute.TriggerDisabled
AzurePipelinesAttribute.Submodules
AzurePipelinesAttribute.FetchDepth
AzurePipelinesAttribute.Clean
AzurePipelinesAttribute.LargeFileStorage
AzurePipelinesAttribute.TriggerBatch
AzurePipelinesAttribute.TriggerBranchesInclude
AzurePipelinesAttribute.TriggerBranchesExclude
AzurePipelinesAttribute.TriggerTagsInclude
AzurePipelinesAttribute.TriggerTagsExclude
AzurePipelinesAttribute.TriggerPathsInclude
AzurePipelinesAttribute.TriggerPathsExclude
AzurePipelinesAttribute.PullRequestsDisabled
AzurePipelinesAttribute.PullRequestsAutoCancel
AzurePipelinesAttribute.PullRequestsBranchesInclude
AzurePipelinesAttribute.PullRequestsBranchesExclude
AzurePipelinesAttribute.PullRequestsPathsInclude
AzurePipelinesAttribute.PullRequestsPathsExclude
AzurePipelinesAttribute.CacheKeyFiles
AzurePipelinesAttribute.CachePaths
AzurePipelinesAttribute.ImportVariableGroups
AzurePipelinesAttribute.ImportSecrets
AzurePipelinesAttribute.EnableAccessToken
ChainedConfigurationAttributeBase.GetTargetDependencies(ExecutableTarget)
ChainedConfigurationAttributeBase.IrrelevantTargetNames
ChainedConfigurationAttributeBase.NonEntryTargets
ChainedConfigurationAttributeBase.ExcludedTargets
ConfigurationAttributeBase.CreateStream()
ConfigurationAttributeBase.SerializeState()
ConfigurationAttributeBase.Build
ConfigurationAttributeBase.DisplayName
ConfigurationAttributeBase.HostName
ConfigurationAttributeBase.Id
ConfigurationAttributeBase.AutoGenerate
Namespace: Microsoft.XboxStudios.NukeExt
Assembly: NukeExt.AzurePipelines.dll
Syntax
public class AzurePipelinesAttribute : AzurePipelinesAttributeBase, IConfigurationGenerator

Constructors

View Source

AzurePipelinesAttribute(string?, bool)

Declaration
public AzurePipelinesAttribute(string? suffix = null, bool disableDeployment = false)
Parameters
Type Name Description
string suffix
bool disableDeployment

Properties

View Source

DeployFromBranch

Gets or sets the branch to deploy from.

Declaration
[Parameter("The branch to deploy from.")]
public string? DeployFromBranch { get; set; }
Property Value
Type Description
string
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.

View Source

DeployFromOrTriggerBranch

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

Declaration
protected string? DeployFromOrTriggerBranch { get; }
Property Value
Type Description
string
View Source

DeploymentModel

Gets or sets the deployment model.

Declaration
[Parameter("The deployment model (StudiosQualityTech, StudiosQualityTechViewPromotion, XboxStudiosQuality, or ArtifactsOnly)")]
public AzurePipelinesDeploymentModel DeploymentModel { get; set; }
Property Value
Type Description
AzurePipelinesDeploymentModel
View Source

DeploymentStageTemplate

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

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

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

View Source

DisableDeployment

Gets or sets a value indicating whether to disable deployment.

Declaration
[Parameter("Whether to disable deployment")]
public bool DisableDeployment { get; set; }
Property Value
Type Description
bool
View Source

EnableNuGetDeploymentWithStageTemplate

Gets or sets a value indicating whether to enable NuGet deployment alongside a deployment stage template.

Declaration
[Parameter("Whether to enable NuGet deployment alongside a deployment stage template")]
public bool EnableNuGetDeploymentWithStageTemplate { get; set; }
Property Value
Type Description
bool
View Source

NuGetFeeds

Gets or sets custom definitions for NuGet deployment environment names and feed/view IDs.

Declaration
[Parameter("Custom definitions for NuGet deployment environment names and feed/view IDs")]
public string[]? NuGetFeeds { get; set; }
Property Value
Type Description
string[]
View Source

PrereleaseBranches

Gets or sets the prerelease branches to deploy from.

Declaration
[Parameter("The branches to deploy prelease artifacts from.")]
public string? PrereleaseBranches { get; set; }
Property Value
Type Description
string
Remarks

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

View Source

RelevantTargetNames

Declaration
public override IEnumerable<string> RelevantTargetNames { get; }
Property Value
Type Description
IEnumerable<string>
Overrides
Nuke.Common.CI.AzurePipelines.AzurePipelinesAttribute.RelevantTargetNames

Methods

View Source

CreateDefaultDeploymentStages()

Declaration
protected IEnumerable<AzurePipelinesStageExt> CreateDefaultDeploymentStages()
Returns
Type Description
IEnumerable<AzurePipelinesStageExt>
View Source

CreateDeploymentStage()

Declaration
protected virtual AzurePipelinesStageExt? CreateDeploymentStage()
Returns
Type Description
AzurePipelinesStageExt
View Source

CreateDeploymentStages()

Declaration
protected override IEnumerable<AzurePipelinesStageExt> CreateDeploymentStages()
Returns
Type Description
IEnumerable<AzurePipelinesStageExt>
Overrides
View Source

MergeSteps(AzurePipelinesJob[])

Declaration
protected override IEnumerable<AzurePipelinesStep> MergeSteps(AzurePipelinesJob[] jobs)
Parameters
Type Name Description
AzurePipelinesJob[] jobs
Returns
Type Description
IEnumerable<AzurePipelinesStep>
Overrides

Implements

Nuke.Common.CI.IConfigurationGenerator