RecipeMetadata

All Cookstyle Cops


The department is: Chef/RedundantCode

The full name of the cop is: Chef/RedundantCode/RecipeMetadata


Enabled by default Supports autocorrection Target Chef Version
Enabled Yes All Versions

The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook’s README.md file instead.

Examples

incorrect

recipe 'openldap::default', 'Install and configure OpenLDAP'

Configurable attributes

Name Default value Configurable values
Version Added 5.6.0 String
Include
  • **/metadata.rb
Array

© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata/