#Cake

Cake (C# Make) is a build automation system with a C# DSL to do things like compiling code, copy files/folders, running unit tests, compress files and build NuGet packages.

Platform	Status
Windows
Linux / OS X

Table of contents

1. Documentation
2. Example
   • Install the Cake bootstrapper
   • Create a Cake script
   • Run it!
3. Contributing
4. Get in touch
5. License

Documentation

You can read the latest documentation at http://cakebuild.net/.

Example

This example dowloads the Cake bootstrapper and executes a simple build script. The bootstrapper is used to bootstrap Cake in a simple way and is not in required in any way to execute build scripts. If you prefer to invoke the Cake executable yourself, take a look at the command line usage.

This example is also available on our homepage: http://cakebuild.net/docs/tutorials/setting-up-a-new-project

1. Install the Cake bootstrapper

The bootstrapper is used to download Cake and the tools required by the build script.

Windows

Invoke-WebRequest http://cakebuild.net/bootstrapper/windows -OutFile build.ps1

Linux

curl -Lsfo build.sh http://cakebuild.net/bootstrapper/linux

OS X

curl -Lsfo build.sh http://cakebuild.net/bootstrapper/osx

2. Create a Cake script

Add a cake script called build.cake to the same location as the bootstrapper script that you downloaded.

var target = Argument("target", "Default");

Task("Default")
  .Does(() =>
{
  Information("Hello World!");
});

RunTarget(target);

3. Run it!

Windows

# Execute the bootstrapper script.
./build.ps1

Linux / OS X

# Adjust the permissions for the bootstrapper script.
chmod +x build.sh

# Execute the bootstrapper script.
./build.sh

Contributing

So you’re thinking about contributing to Cake? Great! It’s really appreciated.

Make sure you've read the contribution guidelines before sending that epic pull request.

• Fork the repository.
• Make your feature addition or bug fix.
• Don't forget the unit tests.
• Send a pull request.

Get in touch

License

Copyright © Patrik Svensson, Mattias Karlsson, Gary Ewan Park and contributors. Cake is provided as-is under the MIT license. For more information see LICENSE.

• For Roslyn, see https://github.com/dotnet/roslyn/blob/master/License.txt
• For Mono.CSharp, see https://github.com/mono/mono/blob/master/mcs/LICENSE
• For Autofac, see https://github.com/autofac/Autofac/blob/master/LICENSE
• For NuGet.Core, see https://nuget.codeplex.com/license