Interface IPublish

A build which publishes binaries.

Inherited Members

ICompile.Compile

ICompile.CompileSettingsBase

ICompile.CompileSettings

ICompile.RunCompile()

ICompile.RunCompileWithBinLog()

IHasGitVersion.Versioning

IHasGitVersion.AddGitVersioning

IHasGitVersion.TrySetCloudBuildNumber()

IRestore.Restore

IRestore.RestoreSettingsBase

IRestore.RestoreSettings

IRestore.RunRestore()

IHasArtifacts.ArtifactsDirectory

IHasArtifacts.ArtifactsDirectoryOrDefault

INukeBuild.ReportSummary(Configure<Dictionary<string, string>>)

INukeBuild.TryGetValue<T>(Expression<Func<T>>)

INukeBuild.TryGetValue<T>(Expression<Func<object>>)

INukeBuild.ExecutionPlan

INukeBuild.InvokedTargets

INukeBuild.SkippedTargets

INukeBuild.ScheduledTargets

INukeBuild.RunningTargets

INukeBuild.AbortedTargets

INukeBuild.FailedTargets

INukeBuild.SucceededTargets

INukeBuild.FinishedTargets

INukeBuild.IsSucceeding

INukeBuild.IsFailing

INukeBuild.IsFinished

INukeBuild.ExitCode

INukeBuild.RootDirectory

INukeBuild.TemporaryDirectory

INukeBuild.BuildAssemblyFile

INukeBuild.BuildAssemblyDirectory

INukeBuild.BuildProjectDirectory

INukeBuild.BuildProjectFile

INukeBuild.Verbosity

INukeBuild.Host

INukeBuild.Plan

INukeBuild.Help

INukeBuild.NoLogo

INukeBuild.IsLocalBuild

INukeBuild.IsServerBuild

INukeBuild.Continue

INukeBuild.Partition

Namespace: Microsoft.XboxStudios.NukeExt

Assembly: NukeExt.Components.dll

Syntax

public interface IPublish : ICompile, IHasGitVersion, IRestore, IHasArtifacts, INukeBuild

Properties

Publish

Gets the target to publish binaries.

Declaration

Target Publish { get; }

Property Value

Type	Description
Target

PublishDirectory

Gets the custom directory to publish binaries to, if any.

Declaration

AbsolutePath? PublishDirectory { get; }

Property Value

Type	Description
AbsolutePath

PublishDirectoryOrDefault

Gets the directory to publish binaries to.

Declaration

AbsolutePath PublishDirectoryOrDefault { get; }

Property Value

Type	Description
AbsolutePath

PublishFrameworks

Gets the frameworks to publish, if any. By default, publish all frameworks.

Declaration

string[]? PublishFrameworks { get; }

Property Value

Type	Description
string[]

PublishProjects

Gets the projects to publish, if any. By default, publish the solution.

Declaration

string[]? PublishProjects { get; }

Property Value

Type	Description
string[]

PublishSettings

Gets the custom publish settings.

Declaration

Configure<DotNetPublishSettings> PublishSettings { get; }

Property Value

Type	Description
Configure<DotNetPublishSettings>

PublishSettingsBase

Gets the default publish settings.

Declaration

Configure<DotNetPublishSettings> PublishSettingsBase { get; }

Property Value

Type	Description
Configure<DotNetPublishSettings>

ValidatePublishOutput

Gets a mapping from project name to its expected publish output.

Declaration

string[]? ValidatePublishOutput { get; }

Property Value

Type	Description
string[]

ZipPublishOutput

Gets a value indicating whether to create a ZIP archive for each published project.

Declaration

bool ZipPublishOutput { get; }

Property Value

Type	Description
bool

Methods

DotNetPublish(string?)

Runs dotnet publish.

Declaration

string[]? DotNetPublish(string? project = null)

Parameters

Type	Name	Description
string	project	The project to publish.

Returns

Type	Description
string[]	The target directories that were published.

RunPublish()

Publishes binaries.

Declaration

void RunPublish()

SetPublishFramework(string?)

Configures dotnet publish to a specific framework.

Declaration

Configure<DotNetPublishSettings> SetPublishFramework(string? framework)

Parameters

Type	Name	Description
string	framework	The framework.

Returns

Type	Description
Configure<DotNetPublishSettings>	Configured publish settings.

SetPublishProject(string)

Configures dotnet publish to a specific project.

Declaration

Configure<DotNetPublishSettings> SetPublishProject(string project)

Parameters

Type	Name	Description
string	project	The project.

Returns

Type	Description
Configure<DotNetPublishSettings>	Configured publish settings.

Extension Methods

NukeBuildExtensions.IsInterceptorExecution(INukeBuild)