Recommended Cake Version

Table of Contents

• Goals
• Related rules
• Usage
• Settings
  • Opt-Out

Goals

For addins and modules it is recommended to reference the lowest version of Cake with API compatibility to the latest version.

This is currently version 3.0.0.

Related rules

• CCG0009

This rule is only applied for project types addin and module.

Usage

Using this package automatically enables this guideline.

Settings

Opt-Out

It it possible to opt-out of the check for recommended Cake version using the CakeContribGuidelinesOmitRecommendedCakeVersion setting and setting it's Include to the reference that should not be checked.

(Keep in mind, though, that it is not recommended to opt-out of this feature)

<ItemGroup>
    <CakeContribGuidelinesOmitRecommendedCakeVersion Include="Cake.Common" />
    <CakeContribGuidelinesOmitRecommendedCakeVersion Include="Cake.Core" />
</ItemGroup>