diff options
author | Nathen Harvey <nharvey@customink.com> | 2012-07-31 07:24:57 -0400 |
---|---|---|
committer | Bryan McLellan <btm@opscode.com> | 2012-08-02 09:32:56 -0700 |
commit | e46334c89f5dc00a680c922c714e798ff3617313 (patch) | |
tree | d63da2a3f96e40aae7eebbfde578ba370061ad99 /chef/lib/chef/knife | |
parent | 7f5eb8585b4aec7986c7a5229b1b9b3a6a0c1897 (diff) | |
download | chef-e46334c89f5dc00a680c922c714e798ff3617313.tar.gz |
Making the CHANGELOG template more verbose.
* Adding a header
* Adding a description of the file
* Removing the 'v' that proceeds version numbers
* Adding a note about the initial version of the cookbook
* Including Markdown reference links
Diffstat (limited to 'chef/lib/chef/knife')
-rw-r--r-- | chef/lib/chef/knife/cookbook_create.rb | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/chef/lib/chef/knife/cookbook_create.rb b/chef/lib/chef/knife/cookbook_create.rb index 8f64c15292..b76decfa5e 100644 --- a/chef/lib/chef/knife/cookbook_create.rb +++ b/chef/lib/chef/knife/cookbook_create.rb @@ -185,8 +185,18 @@ EOH unless File.exists?(File.join(dir,cookbook_name,'CHANGELOG.md')) open(File.join(dir, cookbook_name, 'CHANGELOG.md'),'w') do |file| file.puts <<-EOH -## v0.1.0: +# CHANGELOG for #{cookbook_name} +This file is used to list changes made in each version of #{cookbook_name}. + +## 0.1.0: + +* Initial release of #{cookbook_name} + +- - - +Check the [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax) for help with Markdown. + +The [Github Flavored Markdown page](http://github.github.com/github-flavored-markdown/) describes the differences between markdown on github and standard markdown. EOH end end |