Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.61 KB

install.md

File metadata and controls

24 lines (18 loc) · 1.61 KB
Raw

Installation

Due to the fact that Cake Modules are extending and altering the internals of Cake, the module assembly needs to be loaded prior to the main Cake execution. As a result, the only place that this can really happen is during the bootstrapping phase. If you use the latest version of the default bootstrapper this process is made very easy. All you need to do is the following.

  1. Add a Modules folder into your tools folder
  2. Add a packages.config file into the newly created Modules folder
  3. Add the name and version of the module that you want to use. This should look something like: 
    <?xml version="1.0" encoding="utf-8"?>
<packages>
	<package id="Cake.APT.Module" version="0.1.0" />
</packages>
  4. Run the build as normal. During Cake's execution, it will recognise the module assembly which has been restored into the tools/Modules folder, and load it.

Note

Similar to the recommendation regarding only checking in your packages.config and not the entire contents of the Cake tools/ folder, the same recommendation is applied here. Only check in the packages.config file in the Modules folder, and not the entire contents.

Note

These steps assume you are using the nuget.org feed. Custom feeds require additional steps.

Versioning

Note that since modules interact with the internals of Cake, they are tied to a specific version of Cake. The version of Cake supported by the particular module version will always be in the Release Notes of the NuGet package (and therefore also on nuget.org). Make sure to match this version number to the Cake version you're using.