Class DocsAzurePipelinesAttributeBase

Inheritance
object
Attribute
ConfigurationAttributeBase
ChainedConfigurationAttributeBase
AzurePipelinesAttribute
AzurePipelinesAttributeBase
DocsAzurePipelinesAttributeBase
DocFXAzurePipelinesAttribute
DoxygenAzurePipelinesAttribute
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 DocsAzurePipelinesAttributeBase : AzurePipelinesAttributeBase, IConfigurationGenerator

Constructors

View Source

DocsAzurePipelinesAttributeBase(string, string)

Declaration
public DocsAzurePipelinesAttributeBase(string projectName, string suffix)
Parameters
Type Name Description
string projectName
string suffix

Properties

View Source

ProductionBranch

Gets or sets the branch to deploy documentation to production from.

Declaration
[Parameter(null)]
public string ProductionBranch { get; set; }
Property Value
Type Description
string
View Source

ProjectName

Gets or sets the project name to use on SQTechDocs, corresponding to the container to deploy to.

Declaration
[Parameter(null)]
public string ProjectName { get; set; }
Property Value
Type Description
string

Methods

View Source

CreateDeploymentStages()

Declaration
protected override IEnumerable<AzurePipelinesStageExt> CreateDeploymentStages()
Returns
Type Description
IEnumerable<AzurePipelinesStageExt>
Overrides
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

Implements

Nuke.Common.CI.IConfigurationGenerator