You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Cake Build Runner Action

Cake (C# Make) can be used to run various build tools defined in a C# DSL script. This action runs the Cake command-line. For more information about the project and documentation on the command-line arguments, please visit the Cake website.

Name

A name for this action (this will appear within the stage action list).

Enabled

An action which is not enabled is effectively skipped when executing the given stage.

Cake Script

The path and name of the Cake script file to be used. 

Working Folder

The working folder (relative to the build workspace). Optional. If not specified, then the build workspace folder is used. 

Install Cake on agent using NuGet

Optionally run NuGet to install Cake to the agent before running the action. When this is ticked an input box appears to enter the installation location and a new tab appears for entering NuGet settings.  

Install Cake To

Shown when "Install Cake on agent using NuGet" is ticked. Enter the path to a target folder for the NuGet installation. This will generally be a subfolder of the build workspace.

Using 

The Using drop down is populated by any property collector properties whose namespace matches the pattern defined by the Cake Action. The pattern for this action is ^Cake\..*. The default property collector searches the environment path for "cake.exe".

If you create a property collector for this action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue.

For more in-depth explanations on property collectors see Property Collectors.

Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.




Verbosity

The amount of information detail to display in the build log.

Dry Run

Logs the output from running the Cake action without actually performing any tasks.

Experimental

Use the latest build of the Roslyn script engine


Timeout (in seconds) 

How many seconds to wait for the action to finish before timing out. The default is 86400 seconds (24 hours),


Sources

A list of package sources to install the Cake package from. Optional. You can separate multiple sources with semi-colons. 

Install prerelease packages

Optionally install pre-release versions of the Cake package.

Use cache

Optionally attempt to source the Cake package from the NuGet machine cache.

Using 

The Using drop down is populated by any property collector properties whose namespace matches the pattern defined by the NuGet Action. The pattern for this action is ^NuGet\..*. The default property collector searches the environment path for "NuGet.exe".

If you create a property collector for this pre-install action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue. 

For more in-depth explanations on property collectors see Managing Property Collectors.

Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.



  • No labels