summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanielsdeleo <dan@getchef.com>2014-08-12 12:11:03 -0700
committerdanielsdeleo <dan@getchef.com>2014-08-12 12:11:03 -0700
commitd9601d8df71d8b680e4b9e14ed49f14d91813d30 (patch)
treeaf4a2e2bc14dfb50912e4bfcacf668c33deced82
parentba82dc821311e99238260bef01bc3c20c823d523 (diff)
downloadchef-d9601d8df71d8b680e4b9e14ed49f14d91813d30.tar.gz
Update release notes and doc changes files for metadata name change
-rw-r--r--DOC_CHANGES.md8
-rw-r--r--RELEASE_NOTES.md8
2 files changed, 16 insertions, 0 deletions
diff --git a/DOC_CHANGES.md b/DOC_CHANGES.md
index b1121e2bf4..c036433b87 100644
--- a/DOC_CHANGES.md
+++ b/DOC_CHANGES.md
@@ -6,3 +6,11 @@ Example Doc Change:
Description of the required change.
-->
+### Metadata `name` Attribute is Required.
+
+Current documentation states:
+
+> The name of the cookbook. This field is inferred unless specified.
+
+This is no longer correct as of 12.0. The `name` field is required; if
+it is not specified, an error will be raised if it is not specified.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index cefea25f42..db14882996 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -1,5 +1,13 @@
# Chef Client Release Notes 12.0.0:
+## `name` Attribute is Required in Metadata
+
+Previously, the `name` attribute in metadata had no effect on the name
+of an uploaded cookbook, instead the name was always inferred from the
+directory basename of the cookbook. The `name` attribute is now
+respected when determining the name of a cookbook. Furthermore, the
+`name` attribute is required when loading/uploading cookbooks.
+
## http_request resource no longer appends query string
Previously the http_request GET and HEAD requests appended a hard-coded "?message=resource_name"