We gladly accept your contributions. If there is something that you would like to add then you can send a pull request via GitHub. Have a look at the how to contribute guide for more information.
Overview
Overview about features and requirements of the Cake Issues Addin.
| Features | Overview about core features |
| Requirements | The following contains all information regarding the requirements for running Cake.Recipe |
Fundamentals
The following contains all the pieces of core information that you will need in order to use Cake.Recipe.
| recipe.cake file | The entry point for getting started with Cake.Recipe |
| Pre-processor Directive | Responsible for downloading the Cake.Recipe NuGet package |
| SetVariableNames Method | Override the default names of the environment variables used by Cake.Recipe |
| SetParameters Method | Override the parameter values used by Cake.Recipe |
| PrintParameters Method | Prints the values of all parameters used by Cake.Recipe |
| SetToolSettings Method | Override the default tool settings used by Cake.Recipe |
| Build Method | Begin the execution of Cake.Recipe |
| Environment Variables | A list of all the environment variables used by Cake.Recipe |
Usage
How to obtain, configure, and execute Cake.Recipe.
| Getting started with Cake.Recipe | How to get started |
| Conventions | Some notes about the conventions used by Cake.Recipe |
| Issue management | How issues are collected and reported in Cake.Recipe |
| Creating a release | How to create a release using Cake.Recipe |
| Creating a pre-release | How to create a pre release (unstable release) using Cake.Recipe |
| Creating packages | How to create a NuGet or Chocolatey Package with Cake.Recipe |
| Previewing documentation | How to preview documentation with Cake.Recipe |
| Publishing documentation | How to publish documentation with Cake.Recipe |
| Cleaning cache | How to clean the AppVeyor cache with Cake.Recipe |
| Code coverage reports | How to publish code coverage reports with Cake.Recipe |
CI-systems
Overview about CI-systems and how to use them
| AppVeyor | Running on AppVeyor |
| Azure Pipelines | Running on Azure Pipelines |
| GitHub Actions | Building with GitHub Actions |
| TeamCity | Running on TeamCity |
| Travis CI | Running on Travis CI |
Extending
How to extend Cake.Recipe.
| Loading additional scripts | How to add additional tasks into Cake.Recipe |
| Modify built in tasks | How to modify/replace the built in tasks within Cake.Recipe |
| Override generating version | How to replace the GitVersion version generation |
VSCode Extension
| Installation | How to install the Cake.Recipe VSCode Extension |
| Commands | Information about the commands provided by the extension |
| Resources | Helpful information about using the extension |
Resources
Resources for Cake.Recipe
| Blog posts | Blog posts about Cake.Recipe |
| Videos | Videos about using Cake.Recipe |
Contributing
Contributing to Cake.Recipe.
| How to contribute | Instructions on how to contribute to Cake.Recipe |
| How to build Cake.Recipe | Instructions on how to build Cake.Recipe |
| How to release Cake.Recipe | Instructions on how to release Cake.Recipe |
Known Issues
Known issues.
| Running Xunit Tests when targeting .Net Framework | Can cause problems when running on a non-Windows Operating System |
| Publishing Documentation from GitHub Actions | Fails when running on a Windows Operating System |
Upgrading
Information on how to upgrade to new versions of Cake.Recipe
| Upgrading from 1.x to 2.x | Changes and suggestions needed for porting from Cake.Recipe 1.x to 2.x |
| Upgrading from 2.x to 3.x | Changes and suggestions needed for porting from Cake.Recipe 2.x to 3.x |
| Upgrading from 3.x to 4.x | Changes and suggestions needed for porting from Cake.Recipe 3.x to 4.x |