Class ClickTwiceRunner

A wrapper class for manually invoking individual steps of a ClickTwice build pipeline

Inheritance

System.Object

ClickTwiceRunner

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace:Cake.ClickTwice

Assembly:Cake.ClickTwice.dll

Syntax

public class ClickTwiceRunner

Constructors

| Improve this Doc View Source

ClickTwiceRunner(ICakeLog, ICakeEnvironment, IFileSystem, IProcessRunner, IToolLocator)

Initializes a new instance of the ClickTwiceRunner class

Declaration

public ClickTwiceRunner(ICakeLog log, ICakeEnvironment environment, IFileSystem fileSystem, IProcessRunner processRunner, IToolLocator tools)

Parameters

Type	Name	Description
Cake.Core.Diagnostics.ICakeLog	log	The Cake log
Cake.Core.ICakeEnvironment	environment	The Cake environment
Cake.Core.IO.IFileSystem	fileSystem	The Cake filesystem
Cake.Core.IO.IProcessRunner	processRunner	The Cake process runner
Cake.Core.Tooling.IToolLocator	tools	The Cake tool locator

Methods

| Improve this Doc View Source

GenerateManifest(String, InformationSource)

Generates a ClickTwice manifest for the application at the given project path

Declaration

public ManifestPublisher GenerateManifest(string projectFilePath, InformationSource source = InformationSource.Both)

Parameters

Type	Name	Description
System.String	projectFilePath	Path to the project file
InformationSource	source	Not currently used.

Returns

Type	Description
ManifestPublisher	A publisher for the generated manifest

| Improve this Doc View Source

PublishTemplate(DirectoryPath, Action<TemplatePackageSettings>)

Prepares a directory-based ClickTwice template, using the provided metadata

Declaration

public CakeTemplatePublisher PublishTemplate(DirectoryPath templateDirectory, Action<TemplatePackageSettings> configure)

Parameters

Type	Name	Description
Cake.Core.IO.DirectoryPath	templateDirectory	Path to the tempalte directory
System.Action<TemplatePackageSettings>	configure	Action for configuring template package settings

Returns

Type	Description
CakeTemplatePublisher

| Improve this Doc View Source

PublishTemplate(DirectoryPath, String, String, String, String)

Prepares a directory-based ClickTwice template, using the provided metadata

Declaration

public CakeTemplatePublisher PublishTemplate(DirectoryPath templateDirectory, string packageId, string version, string author, string description = null)

Parameters

Type	Name	Description
Cake.Core.IO.DirectoryPath	templateDirectory	Path to the tempalte directory
System.String	packageId	Id of the package to generate
System.String	version	Version of the generated package
System.String	author	Author of the generated package
System.String	description	Optional description of the generated package

Returns

Type	Description
CakeTemplatePublisher

| Improve this Doc View Source

RunInputHandlers(String, IInputHandler[])

Runs the given input handlers on the project at the given path

Declaration

public void RunInputHandlers(string projectFilePath, params IInputHandler[] inputHandlers)

Parameters

Type	Name	Description
System.String	projectFilePath	Path to the project file
IInputHandler[]	inputHandlers	A collection of handlers to process

| Improve this Doc View Source

RunOutputHandlers(String, IOutputHandler[])

Runs the given output handlers on the published app at the given path

Declaration

public void RunOutputHandlers(string publishDirectoryPath, params IOutputHandler[] outputHandlers)

Parameters

Type	Name	Description
System.String	publishDirectoryPath	Path to the published app files
IOutputHandler[]	outputHandlers	A collection of IHandler handlers to process