ICreatePublishSettings Interface

Summary

Contains common settings used by TfxExtensionCreateRunner and TfxExtensionPublishRunner.
graph BT Type["ICreatePublishSettings"] class Type type-node Implementing0["TfxExtensionCreateSettings"]-.->Type click Implementing0 "/api/Cake.Tfx.Extension.Create/TfxExtensionCreateSettings" Implementing1["TfxExtensionPublishSettings"]-.->Type click Implementing1 "/api/Cake.Tfx.Extension.Publish/TfxExtensionPublishSettings"

Syntax

public interface ICreatePublishSettings

Properties

Name Value Summary
BypassValidation bool
Gets or sets a value indicating whether to bypass local validation.
ExtensionId string
Gets or sets a value to use as the extension ID instead of what is specified in the manifest.
LocRoot string
Gets or sets the Root of localization hierarchy
ManifestGlobs ICollection<string>
Gets or sets the List of globs to find manifests.
OutputPath DirectoryPath
Gets or sets the Path to write the VSIX.
Override string
Gets or sets the JSON string which is merged into the manifests, overriding any values.
OverridesFile FilePath
Gets or sets the path to a JSON file with overrides. This partial manifest will always take precedence over any values in the manifests.
Publisher string
Gets or sets a value to use as the publisher ID instead of what is specified in the manifest.
Root DirectoryPath
Gets or sets the Root directory to be used when creating extension.

Extension Methods

Name Value Summary
Dump<ICreatePublishSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ICreatePublishSettings>(ICreatePublishSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ICreatePublishSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<ICreatePublishSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<ICreatePublishSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ICreatePublishSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin