It is possible to have Cake tasks as run configurations:
Currently only run configurations are supported. Debug configurations are not supported.
Configuring run configurations
In order to use the run configurations you must have Cake installed on your machine or in your solution.
Install Cake
To use Cake .NET Tool it needs to be installed globally:
dotnet tool install --global Cake.Tool
This is the default setup in Cake for Rider.
There is currently no support for run configurations for Cake Frosting.
Install Cake using any of the following options:
-
On Windows using Chocolatey to install it globally:
choco install cake.portable
-
Use a bootstrapper.
This requires to setup the bootstrapper(s) under settings
There is currently no support for task runner for Cake runner for .NET Core.
Supported runners
Runner | Supported | Remarks |
---|---|---|
Cake .NET Tool | ||
Cake Frosting | ||
Cake runner for .NET Framework | ||
Cake runner for .NET Core |
Settings
There are multiple configuration settings available under File -> Settings -> Build, Execution, Deployment -> Cake.
All settings are project - specific and stored in the .idea
folder. To share settings across developers, make sure to put CakeRider.xml
under source control.
Generic settings
- Cake file extension
This setting is used to find all Cake files and display them in the Cake Tasks window.
Default:
cake
- Task Regex
This regular expression is used to parse tasks from the Cake files.
Default:
Task\s*?\(\s*?"(.*?)"\s*?\)
- Verbosity
This is the default verbosity to use, when running a task directly from the Cake Tasks window or when creating a new run configuration.
Default:
normal
Search paths
Allows to modify search paths that are used to find all Cake files that are displayed in the Cake Tasks window.
- Search paths
One or multiple starting points to search for Cake files.
The paths are relative to the project root and should use
/
as separator between directories. Default:.
(root of the project directory.) - Exclude expressions
Regular expressions to exclude search paths.
Each path that is found during the search is matched against all configured expressions.
Matches will be excluded.
Default:
.*/tools/.*
Runner settings
Allows to define the runner to use.
Different runners for different operating systems can be set by defining a regular expression which is matched against the system property os.name
.
Default value is dotnet-cake
and dotnet-cake.exe
for Windows.
Using run configurations
Creating run configurations
The configurations can either be created from an existing Cake task, using the Cake Tasks window or created manually using the run configuration editor.
Editing run configurations
An editor for run configurations is available:
Settings in the run configuration
- Script path Path to the Cake file. (This is passed as first argument to the runner.)
- Task
Name of the task to run (This is passed to the runner using
--task=<Task>
.) - Verbosity
Verbosity of the Cake output. (This is passed to the runner using
--verbosity=<Verbosity>
.) - Arguments Arbitrary additional arguments to the runner.
Running builds directly
The Cake Tasks window lists all Cake scripts and their tasks:
Using a double click on a task will run that task immediately:
Alternatively, the buttons at the top of the Cake Tasks window can be used to either run the task immediately, or create a new run configuration.