pratik-bhavsar / cake Goto Github PK

#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.

##Table of contents

1. Roadmap
2. Implemented functionality
3. Example
   • Download Cake
   • Create build script
   • Run build script
4. Documentation
5. Bootstrapper
6. Contributing
7. External add-ons
8. License

##Roadmap

The Cake engine is pretty much done, but there are still improvements to be made. I'm still experimenting with the script API to make it as easy and intuitive as possible, so expect changes along the road.

A roadmap can be found here.

##Implemented functionality

This is a list of some the currently implemented functionality.
For a full list of supported tools, see the DSL reference.

• MSBuild
• MSTest
• xUnit (v1 and v2)
• NUnit
• NuGet
  • Pack
  • Push
  • Restore
  • Sources
• ILMerge
• WiX
  • Candle
  • Light
• SignTool
• File operations
  • Copying
  • Moving
  • Deleting
• Directory operations
  • Creation
  • Cleaning
  • Deleting
• File/Directory globbing
• Compression (zip)
• AssemblyInfo patching
• Release notes parser
• AppVeyor
• MSBuild Resource
  • Solution file parsing
  • Project file parsing
• Octopus deploy
  • Create release

For more information and examples of how to use Cake, see the Documentation.

##Example

###1. Download Cake

C:\Project> NuGet.exe install Cake -OutputDirectory Tools -ExcludeVersion

###2. Create build script

var target = Argument("target", "NuGet");
var configuration = Argument("configuration", "Release");

Task("Clean")
    .Does(() =>
{
    // Clean directories.
    CleanDirectory("./build");
    CleanDirectory("./build/bin");
    CleanDirectories("./src/**/bin/" + configuration);
});

Task("Restore-NuGet-Packages")
    .IsDependentOn("Clean")
    .Does(context =>
{
    // Restore NuGet packages.
    NuGetRestore("./src/Cake.sln");    
});

Task("Build")
    .IsDependentOn("Restore-NuGet-Packages")
    .Does(() =>
{
    MSBuild("./src/Cake.sln", s => 
        s.SetConfiguration(configuration));
});

Task("Unit-Tests")
    .IsDependentOn("Build")
    .Does(() =>
{
    XUnit("./src/**/bin/" + configuration + "/*.Tests.dll");
});

Task("Copy-Files")
    .IsDependentOn("Unit-Tests")
    .Does(() =>
{
    var sourcePath = "./src/Cake/bin/" + configuration;    
    var files = GetFiles(sourcePath + "/**/*.dll") + GetFiles(sourcePath + "/**/*.exe");
    var destinationPath = "./build/bin";

    CopyFiles(files, destinationPath);
});

Task("Pack")
    .IsDependentOn("Copy-Files")
    .Does(() =>
{   
    var root = "./build/bin";
    var output = "./build/" + configuration + ".zip";

    Zip(root, output);
});

Task("NuGet")
    .Description("Create NuGet package")
    .IsDependentOn("Pack")
    .Does(() =>
{
    // Create NuGet package.
    NuGetPack("./Cake.nuspec", new NuGetPackSettings {
        Version = "0.1.0",
        BasePath = "./build/bin",
        OutputDirectory = "./build",
        NoPackageAnalysis = true
    });
});

RunTarget(target);

###3. Run build script

C:\Project\Tools\Cake> Cake.exe ../../build.csx -verbosity=verbose -target=Pack

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

The Cake Bootstrapper is a Powershell cmdlet that helps you set up a new Cake build by downloading dependencies, setting up the bootstrapper script and creating a Cake build script.

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. Bonus for topic branches. Funny .gif will be your reward.

Cake.AliaSql: https://www.nuget.org/packages/Cake.AliaSql
Cake.Unity: https://github.com/patriksvensson/Cake.Unity
Cake.Slack: https://github.com/WCOMAB/Cake.Slack

Copyright © 2014 - 2015, Patrik Svensson, Mattias Karlsson 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