Class AzurePipelinesAttributeBase

Inheritance
object
Attribute
ConfigurationAttributeBase
ChainedConfigurationAttributeBase
AzurePipelinesAttribute
AzurePipelinesAttributeBase
AzurePipelinesAttribute
DocsAzurePipelinesAttributeBase
Implements
IConfigurationGenerator
Inherited Members
AzurePipelinesAttribute.GetVcsPushTrigger()
AzurePipelinesAttribute.GetVcsPullRequestTrigger()
AzurePipelinesAttribute.GetImports()
AzurePipelinesAttribute.IdPostfix
AzurePipelinesAttribute.HostType
AzurePipelinesAttribute.ConfigurationFile
AzurePipelinesAttribute.GeneratedFiles
AzurePipelinesAttribute.ConfigurationDirectory
AzurePipelinesAttribute.RelevantTargetNames
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 abstract class AzurePipelinesAttributeBase : AzurePipelinesAttribute, IConfigurationGenerator

Constructors

View Source

AzurePipelinesAttributeBase(string?)

Declaration
public AzurePipelinesAttributeBase(string? suffix = null)
Parameters
Type Name Description
string suffix

Fields

View Source

DefaultImage

Declaration
public const AzurePipelinesImage DefaultImage = WindowsLatest
Field Value
Type Description
AzurePipelinesImage

Properties

View Source

BuildCmdPath

Declaration
protected override string BuildCmdPath { get; }
Property Value
Type Description
string
Overrides
Nuke.Common.CI.ConfigurationAttributeBase.BuildCmdPath
View Source

BuildTimeoutInMinutes

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

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

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

View Source

DotNetSDKs

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

Declaration
[Parameter("The .NET SDKs to install before running the build.")]
public string[] DotNetSDKs { get; set; }
Property Value
Type Description
string[]
View Source

Image

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

Declaration
public AzurePipelinesImage Image { get; set; }
Property Value
Type Description
AzurePipelinesImage
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.

View Source

ImageName

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

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

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

View Source

NuGetTimeoutInSeconds

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

Declaration
[Parameter("The NuGet authentication and request timeouts, in seconds, if any")]
public uint? NuGetTimeoutInSeconds { get; set; }
Property Value
Type Description
uint?
View Source

NugetConfigPath

Gets or sets the NuGet config path to use.

Declaration
[Parameter("The NuGet config path to use")]
public string? NugetConfigPath { get; set; }
Property Value
Type Description
string
View Source

NukeBuildDirectory

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

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

If null, this defaults to the root directory.

View Source

NukeToolPackageName

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

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

PoolName

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

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

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

Methods

View Source

CreateDeploymentStages()

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

CreateSetupSteps()

Declaration
protected virtual IEnumerable<AzurePipelinesStep> CreateSetupSteps()
Returns
Type Description
IEnumerable<AzurePipelinesStep>
View Source

GetConfiguration(IReadOnlyCollection<ExecutableTarget>)

Declaration
public override AzurePipelinesConfigurationExt GetConfiguration(IReadOnlyCollection<ExecutableTarget> relevantTargets)
Parameters
Type Name Description
IReadOnlyCollection<ExecutableTarget> relevantTargets
Returns
Type Description
AzurePipelinesConfigurationExt
Overrides
View Source

GetPipelines()

Declaration
protected virtual IEnumerable<Pipeline> GetPipelines()
Returns
Type Description
IEnumerable<Pipeline>
View Source

GetRepositories()

Declaration
protected virtual IEnumerable<Repository> GetRepositories()
Returns
Type Description
IEnumerable<Repository>
View Source

GetStage(string, IReadOnlyCollection<ExecutableTarget>)

Declaration
protected virtual AzurePipelinesStageExt GetStage(string name, IReadOnlyCollection<ExecutableTarget> relevantTargets)
Parameters
Type Name Description
string name
IReadOnlyCollection<ExecutableTarget> relevantTargets
Returns
Type Description
AzurePipelinesStageExt
View Source

GetSteps(ExecutableTarget, IReadOnlyCollection<ExecutableTarget>, AzurePipelinesImage)

Declaration
protected override IEnumerable<AzurePipelinesStep> GetSteps(ExecutableTarget executableTarget, IReadOnlyCollection<ExecutableTarget> relevantTargets, AzurePipelinesImage image)
Parameters
Type Name Description
ExecutableTarget executableTarget
IReadOnlyCollection<ExecutableTarget> relevantTargets
AzurePipelinesImage image
Returns
Type Description
IEnumerable<AzurePipelinesStep>
Overrides
View Source

MergeSteps(AzurePipelinesJob[])

Declaration
protected virtual IEnumerable<AzurePipelinesStep> MergeSteps(AzurePipelinesJob[] jobs)
Parameters
Type Name Description
AzurePipelinesJob[] jobs
Returns
Type Description
IEnumerable<AzurePipelinesStep>
View Source

MergeStepsToJob(AzurePipelinesJob[])

Declaration
protected virtual AzurePipelinesJobExt MergeStepsToJob(AzurePipelinesJob[] jobs)
Parameters
Type Name Description
AzurePipelinesJob[] jobs
Returns
Type Description
AzurePipelinesJobExt

Implements

Nuke.Common.CI.IConfigurationGenerator