Skip to main content

RecipeMetadata

All Cookstyle Cops


The department is: Chef/RedundantCode

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


Enabled by defaultSupports autocorrectionTarget Chef Version
EnabledYesAll 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

NameDefault valueConfigurable values
Version Added5.6.0String
Include
  • **/metadata.rb
Array

Was this page helpful?