FlubuCore

"FlubuCore - Fluent Builder Core" is a cross platform build and deployment automation system. You can define your build and deployment scripts in C# using an intuitive fluent interface. This gives you code completion, IntelliSense, debugging, FlubuCore custom analyzers, and native access to the whole .NET ecosystem inside of your scripts.

Features and Advantages

• Intuitive an easy to learn. C#, fluent interface, and IntelliSense make even most complex script creation a breeze.

  context.CreateTarget("Example")
    .DependsOn(fetchBuildVersionTarget)
    .AddTask(x => x.CompileSolutionTask())
    .AddTask(x => x.PublishNuGetPackageTask("packageId", "pathToNuspec"))
        .When(c => c.BuildSystems().Jenkins().IsRunningOnJenkins);
  

• Large number of often used built-in tasks like e.g. running tests, managing IIS, creating deployment packages, publishing NuGet packages, executing PowerShell scripts and many more.

  target
      .AddTask(x => x.CompileSolutionTask())
      .AddTask(x => x.CopyFileTask(source, destination, true))
      .AddTask(x => x.IisTasks()
                      .CreateAppPoolTask("Example app pool")
                      .Mode(CreateApplicationPoolMode.DoNothingIfExists));
  

• Execute your own custom C# code.

  context.CreateTarget("MyCustomBuildTarget")
       .AddTask(x => x.CompileSolutionTask())
       .Do(MyCustomMethod)
       .Do(NuGetPackageReferencingExample);
  

• Reference any .NET library, NuGet package or C# source code in your scripts.

  //#ass .\Lib\EntityFramework.dll
  //#nuget Newtonsoft.json, 11.0.2
  public class BuildScript : DefaultBuildScript
  {
     public void NuGetPackageReferencingExample(ITaskContext context)
      {
          JsonConvert.SerializeObject("Example");
      }
  }
  

• Easily run any external program or console command in your script.

  session.CreateTarget("Run.Libz")
      .AddTask(x => x.RunProgramTask(@"packages\LibZ.Tool\1.2.0\tools\libz.exe")
          .WorkingFolder(@".\src")
          .WithArguments("add")
          .WithArguments("--libz", "Assemblies.libz"));
  

• Pass command line arguments, settings from json configuration file or enviroment variables to your script.

public class SimpleScript : DefaultBuildScript
{
   [FromArg("sn", "If true app is deployed on second node. Otherwise not.")]
   public bool deployOnSecondNode { get; set; }


    protected override void ConfigureTargets(ITaskContext context)
    {
        context.CreateTarget("compile")
           .AddTask(x => x.CompileSolutionTask()
               .ForMember(y => y.SolutionFileName("someSolution.sln"), "solution", "The solution to build.")); 
    }
 }

 flubu.exe compile -solution=someOtherSolution.sln -sn=true

• Extending FlubuCore fluent interface by writing your own FlubuCore tasks.

  public class ExampleFlubuPluginTask : TaskBase<int, ExampleFlubuPluginTask>
  {
      protected override int DoExecute(ITaskContextInternal context)
      {
          // Write your task logic here.
          return 0;
      }
  }
  

• Asynchronous execution of tasks, target dependencies and custom code.

  session.CreateTarget("Run.Tests")
      .AddTaskAsync(x => x.NUnitTaskForNunitV3("TestProjectName1"))
      .AddTaskAsync(x => x.NUnitTaskForNunitV3("TestProjectName1"))
      .AddTaskAsync(x => x.NUnitTaskForNunitV3("TestProjectName3"));
  

• Full .NET Core support including the global CLI tool

  dotnet tool install --global FlubuCore.GlobalTool
  flubu compile
  

• Possibility to test and debug your build scripts.

  context.WaitForDebugger();
  

• Easily automate deployments remotely via the FlubuCore Web API.

• Possibility to use FlubuCore tasks in any other .NET application.

• Cake have a lot of addins that are quite usefull. If needed any of them can be used in FlubuCore.

• Improved developer experience with FlubuCore custom analyzers.

Getting Started

Using FlubuCore is straightforward and very simple :-) It is also fully and throughly documented.

The Getting Started chapter on FlubuCore Wiki will help you set up your first FlubuCore build in no time.

A comprehensive list of features that FlubuCore has to offer with descriptions can be found in the Build Script Fundamentals chapter.

Once you have your build and deployment scripts defined, the following Wiki chapters will explain how to run them:

• For .NET Framework projects use FlubuCore.Runner
• For .NET Core projects use FlubuCore CLI global tool

Examples

Aside from the detailed Wiki FlubuCore comes with example projects that reflect real-life situations. The examples can be found in the separate Examples repository.

These examples will help you to get quickly start with FlubuCore:

• .NET Framework build example

• .NET Core build example

• Deployment script example

Have a question?

Contributing

Please see CONTRIBUTING.md.

Ways to Contribute

• Spread the word about the project.
• If you like the project please don't forget to give it a star so that the community get's bigger.
• Improve documentation.
• Report, fix a bug.
• Implement a new feature.
• Discuss potential ways to improve project.
• Improve existing implementation, performance, etc.

Release Notes and Roadmap

Notable FlubuCore changes by release can be found in What's new wiki section. See release notes for full set of changes.

You can see FlubuCore roadmap by exploring opened milestones.

Thanks

Special thanks to @ironcev for greatly improving readme and for giving some valuable advices.