/frosting

A stand-alone .NET Core runner and host for Cake.

Primary LanguageC#MIT LicenseMIT

Frosting

AppVeyor branch MyGet

A .NET Core host for Cake, that allows you to write your build scripts as a (portable) console application (netcoreapp1.1 or net461). Frosting is currently in alpha, but more information, documentation and samples will be added soon.

Expect things to move around initially. Especially naming of things.

Table of Contents

  1. Example
  2. Acknowledgement
  3. License
  4. Thanks
  5. Code of Conduct
  6. .NET Foundation

Example

1. Install .NET Core SDK 1.0.4 or later

You can find the SDK at https://www.microsoft.com/net/download/core.

2. Install the template

Cake.Frosting is currently in preview, so you will have to specify the template version explicitly.

> dotnet new --install Cake.Frosting.Template::0.1.0-*

3. Create a new Frosting project

Now it's time to create a new Frosting project.
Go to the repository where you want to add a new Frosting build script and run the following command:

> dotnet new cakefrosting

4. Profit

Now you should be able to run your newly created builds script.

> ./build.ps1

NOTE: You're not supposed to commit the produced binaries to your repository.
The above command is what you're expected to run from your bootstrapper.

Building from source

.NET Core SDK

To build from source, you will need to have .NET Core SDK 1.0.4 installed on your machine.

Visual Studio 2017 (optional)

If you want to develop using Visual Studio, then you need to use Visual Studio 2017 (15.2) or higher.

Acknowledgement

The API for configuring and running the host have been heavily influenced by the ASP.NET Core hosting API.

License

Copyright © .NET Foundation and contributors.
Frosting is provided as-is under the MIT license. For more information see LICENSE.

Thanks

A big thank you has to go to JetBrains who provide each of the Cake developers with an Open Source License for ReSharper that helps with the development of Cake.

The Cake Team would also like to say thank you to the guys at MyGet for their support in providing a Professional subscription which allows us to continue to push all of our pre-release editions of Cake NuGet packages for early consumption by the Cake community.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.