knife-cookbook-readme 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +1 -0
- data/CHANGELOG.md +8 -0
- data/README.md +10 -0
- data/lib/chef/knife/cookbook_readme_from.rb +1 -1
- data/lib/knife_cookbook_readme/readme_model.rb +4 -0
- data/lib/knife_cookbook_readme/version.rb +1 -1
- data/{templates → template}/README.md.erb +9 -9
- metadata +13 -14
- data/Gemfile.lock +0 -61
data/.gitignore
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,11 @@
|
|
1
|
+
v0.1.2 (Jul 17 2013)
|
2
|
+
--------------------
|
3
|
+
|
4
|
+
* Add title to generated README and decrease level of headings.
|
5
|
+
* Rename "templates" directory to "template".
|
6
|
+
* Add alternative Chef documentation tools to README.
|
7
|
+
* Remove Gemfile.lock.
|
8
|
+
|
1
9
|
v0.1.1 (Feb 20 2013)
|
2
10
|
--------------------
|
3
11
|
|
data/README.md
CHANGED
@@ -49,6 +49,16 @@ Note that the command will write the generated output to STDOUT. Simply redirect
|
|
49
49
|
the output to `README.md` to write to a file.
|
50
50
|
|
51
51
|
|
52
|
+
Alternatives
|
53
|
+
------------
|
54
|
+
|
55
|
+
Here is a list of other documentation tools for Chef (sorted alphabetically):
|
56
|
+
|
57
|
+
* [knife-cookbook-doc](https://github.com/realityforge/knife-cookbook-doc)
|
58
|
+
([blog post](http://realityforge.org/code/2013/04/01/documenting-cookbooks.html))
|
59
|
+
* [yard-chef](https://github.com/rightscale/yard-chef)
|
60
|
+
|
61
|
+
|
52
62
|
License
|
53
63
|
-------
|
54
64
|
|
@@ -21,7 +21,7 @@ module KnifeCookbookReadme
|
|
21
21
|
option :template_file,
|
22
22
|
:short => '-t',
|
23
23
|
:long => '--template FILE',
|
24
|
-
:default => File.expand_path('../../../../
|
24
|
+
:default => File.expand_path('../../../../template/README.md.erb',
|
25
25
|
Pathname.new(__FILE__).realpath),
|
26
26
|
:description => 'Set template file used to render README.md'
|
27
27
|
|
@@ -1,12 +1,12 @@
|
|
1
|
-
|
2
|
-
|
1
|
+
<%= title %>
|
2
|
+
<%= '=' * title.length %>
|
3
3
|
|
4
4
|
<%= description %>
|
5
5
|
|
6
6
|
Requirements
|
7
|
-
|
7
|
+
------------
|
8
8
|
|
9
|
-
|
9
|
+
### Platform:
|
10
10
|
|
11
11
|
<% unless platforms.empty? %>
|
12
12
|
<% platforms.each do |platform| %>
|
@@ -16,7 +16,7 @@ Requirements
|
|
16
16
|
*No platforms defined*
|
17
17
|
<% end %>
|
18
18
|
|
19
|
-
|
19
|
+
### Cookbooks:
|
20
20
|
|
21
21
|
<% unless dependencies.empty? %>
|
22
22
|
<% dependencies.each do |cookbook| %>
|
@@ -27,7 +27,7 @@ Requirements
|
|
27
27
|
<% end %>
|
28
28
|
|
29
29
|
Attributes
|
30
|
-
|
30
|
+
----------
|
31
31
|
|
32
32
|
<% unless attributes.empty? %>
|
33
33
|
<table>
|
@@ -49,11 +49,11 @@ Attributes
|
|
49
49
|
<% end %>
|
50
50
|
|
51
51
|
Recipes
|
52
|
-
|
52
|
+
-------
|
53
53
|
|
54
54
|
<% unless recipes.empty? %>
|
55
55
|
<% recipes.each do |recipe, description| %>
|
56
|
-
|
56
|
+
### <%= recipe %>
|
57
57
|
|
58
58
|
<%= description %>
|
59
59
|
|
@@ -63,7 +63,7 @@ Recipes
|
|
63
63
|
<% end %>
|
64
64
|
|
65
65
|
License and Author
|
66
|
-
|
66
|
+
------------------
|
67
67
|
|
68
68
|
Author:: <%= author %> (<<%= author_email %>>)
|
69
69
|
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: knife-cookbook-readme
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.2
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,14 +9,14 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2013-
|
12
|
+
date: 2013-07-17 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: chef
|
16
16
|
requirement: !ruby/object:Gem::Requirement
|
17
17
|
none: false
|
18
18
|
requirements:
|
19
|
-
- -
|
19
|
+
- - '>='
|
20
20
|
- !ruby/object:Gem::Version
|
21
21
|
version: '0'
|
22
22
|
type: :runtime
|
@@ -24,7 +24,7 @@ dependencies:
|
|
24
24
|
version_requirements: !ruby/object:Gem::Requirement
|
25
25
|
none: false
|
26
26
|
requirements:
|
27
|
-
- -
|
27
|
+
- - '>='
|
28
28
|
- !ruby/object:Gem::Version
|
29
29
|
version: '0'
|
30
30
|
- !ruby/object:Gem::Dependency
|
@@ -32,7 +32,7 @@ dependencies:
|
|
32
32
|
requirement: !ruby/object:Gem::Requirement
|
33
33
|
none: false
|
34
34
|
requirements:
|
35
|
-
- -
|
35
|
+
- - '>='
|
36
36
|
- !ruby/object:Gem::Version
|
37
37
|
version: '0'
|
38
38
|
type: :runtime
|
@@ -40,7 +40,7 @@ dependencies:
|
|
40
40
|
version_requirements: !ruby/object:Gem::Requirement
|
41
41
|
none: false
|
42
42
|
requirements:
|
43
|
-
- -
|
43
|
+
- - '>='
|
44
44
|
- !ruby/object:Gem::Version
|
45
45
|
version: '0'
|
46
46
|
- !ruby/object:Gem::Dependency
|
@@ -48,7 +48,7 @@ dependencies:
|
|
48
48
|
requirement: !ruby/object:Gem::Requirement
|
49
49
|
none: false
|
50
50
|
requirements:
|
51
|
-
- -
|
51
|
+
- - '>='
|
52
52
|
- !ruby/object:Gem::Version
|
53
53
|
version: '0'
|
54
54
|
type: :development
|
@@ -56,7 +56,7 @@ dependencies:
|
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
57
57
|
none: false
|
58
58
|
requirements:
|
59
|
-
- -
|
59
|
+
- - '>='
|
60
60
|
- !ruby/object:Gem::Version
|
61
61
|
version: '0'
|
62
62
|
description: Knife plugin to generate README.md from metadata.rb
|
@@ -69,7 +69,6 @@ files:
|
|
69
69
|
- .gitignore
|
70
70
|
- CHANGELOG.md
|
71
71
|
- Gemfile
|
72
|
-
- Gemfile.lock
|
73
72
|
- LICENSE
|
74
73
|
- README.md
|
75
74
|
- Rakefile
|
@@ -77,7 +76,7 @@ files:
|
|
77
76
|
- lib/chef/knife/cookbook_readme_from.rb
|
78
77
|
- lib/knife_cookbook_readme/readme_model.rb
|
79
78
|
- lib/knife_cookbook_readme/version.rb
|
80
|
-
-
|
79
|
+
- template/README.md.erb
|
81
80
|
homepage: http://mlafeldt.github.com/knife-cookbook-readme
|
82
81
|
licenses:
|
83
82
|
- Apache 2.0
|
@@ -88,21 +87,21 @@ require_paths:
|
|
88
87
|
required_ruby_version: !ruby/object:Gem::Requirement
|
89
88
|
none: false
|
90
89
|
requirements:
|
91
|
-
- -
|
90
|
+
- - '>='
|
92
91
|
- !ruby/object:Gem::Version
|
93
92
|
version: '0'
|
94
93
|
segments:
|
95
94
|
- 0
|
96
|
-
hash: -
|
95
|
+
hash: -921780819663544875
|
97
96
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
98
97
|
none: false
|
99
98
|
requirements:
|
100
|
-
- -
|
99
|
+
- - '>='
|
101
100
|
- !ruby/object:Gem::Version
|
102
101
|
version: '0'
|
103
102
|
segments:
|
104
103
|
- 0
|
105
|
-
hash: -
|
104
|
+
hash: -921780819663544875
|
106
105
|
requirements: []
|
107
106
|
rubyforge_project:
|
108
107
|
rubygems_version: 1.8.25
|
data/Gemfile.lock
DELETED
@@ -1,61 +0,0 @@
|
|
1
|
-
PATH
|
2
|
-
remote: .
|
3
|
-
specs:
|
4
|
-
knife-cookbook-readme (0.1.1)
|
5
|
-
chef
|
6
|
-
erubis
|
7
|
-
|
8
|
-
GEM
|
9
|
-
remote: https://rubygems.org/
|
10
|
-
specs:
|
11
|
-
chef (11.4.0)
|
12
|
-
erubis
|
13
|
-
highline (>= 1.6.9)
|
14
|
-
json (>= 1.4.4, <= 1.7.7)
|
15
|
-
mixlib-authentication (>= 1.3.0)
|
16
|
-
mixlib-cli (~> 1.3.0)
|
17
|
-
mixlib-config (>= 1.1.2)
|
18
|
-
mixlib-log (>= 1.3.0)
|
19
|
-
mixlib-shellout
|
20
|
-
net-ssh (~> 2.6)
|
21
|
-
net-ssh-multi (~> 1.1.0)
|
22
|
-
ohai (>= 0.6.0)
|
23
|
-
rest-client (>= 1.0.4, < 1.7.0)
|
24
|
-
yajl-ruby (~> 1.1)
|
25
|
-
erubis (2.7.0)
|
26
|
-
highline (1.6.15)
|
27
|
-
ipaddress (0.8.0)
|
28
|
-
json (1.7.7)
|
29
|
-
mime-types (1.21)
|
30
|
-
mixlib-authentication (1.3.0)
|
31
|
-
mixlib-log
|
32
|
-
mixlib-cli (1.3.0)
|
33
|
-
mixlib-config (1.1.2)
|
34
|
-
mixlib-log (1.4.1)
|
35
|
-
mixlib-shellout (1.1.0)
|
36
|
-
net-ssh (2.6.5)
|
37
|
-
net-ssh-gateway (1.2.0)
|
38
|
-
net-ssh (>= 2.6.5)
|
39
|
-
net-ssh-multi (1.1)
|
40
|
-
net-ssh (>= 2.1.4)
|
41
|
-
net-ssh-gateway (>= 0.99.0)
|
42
|
-
ohai (6.16.0)
|
43
|
-
ipaddress
|
44
|
-
mixlib-cli
|
45
|
-
mixlib-config
|
46
|
-
mixlib-log
|
47
|
-
mixlib-shellout
|
48
|
-
systemu
|
49
|
-
yajl-ruby
|
50
|
-
rake (10.0.3)
|
51
|
-
rest-client (1.6.7)
|
52
|
-
mime-types (>= 1.16)
|
53
|
-
systemu (2.5.2)
|
54
|
-
yajl-ruby (1.1.0)
|
55
|
-
|
56
|
-
PLATFORMS
|
57
|
-
ruby
|
58
|
-
|
59
|
-
DEPENDENCIES
|
60
|
-
knife-cookbook-readme!
|
61
|
-
rake
|