Due to the fact that Cake Modules are extending and altering the internals of the 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.
- Add a modules folder into your tools folder
- Add a packages.config file into the newly created modules folder
- Add the name and version of the Module that you want to use. NOTE: At this point, the assumption is that you are hosting the Module on NuGet.org. If this is not the case, then additional steps would be required.
- An example packages.config file is shown below:
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="Cake.Chocolatey.Module" version="0.1.0" />
</packages>
- Run the build as normal. During the Cake Execution, it will recognise the Module Assembly which as been restored into the
tools/modulesfolder, and load it.
NOTE: Similar to the recommendation here 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.