knife-cookbook-doc 0.27.0 → 0.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.gitignore +1 -0
- data/.travis.yml +67 -17
- data/CHANGELOG.md +16 -0
- data/Rakefile +9 -0
- data/fixture/README-expected.md +21 -1
- data/fixture/README-expected_legacy.md +75 -0
- data/fixture/gemfile +1 -0
- data/fixture/libraries/default.rb +7 -0
- data/fixture/metadata.rb +2 -0
- data/fixture/metadata_legacy.rb +10 -0
- data/fixture/resources/space.rb +13 -0
- data/lib/chef/knife/README.md.erb +7 -0
- data/lib/chef/knife/cookbook_doc.rb +6 -0
- data/lib/knife_cookbook_doc/libraries_model.rb +13 -0
- data/lib/knife_cookbook_doc/rake_task.rb +1 -0
- data/lib/knife_cookbook_doc/readme_model.rb +37 -3
- data/lib/knife_cookbook_doc/resource_model.rb +3 -3
- data/lib/knife_cookbook_doc/version.rb +1 -1
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 32146e1b9e4922d6ad79b91e13b265644ab5d015f0c5cbdb3ee19cbc41d7e3da
|
4
|
+
data.tar.gz: 7b743e9a1dd63eb357f54bc3713c81c902f86f740163da01456cf7035b481913
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b53f6f936367ddd06a000582f7c7e7f8aed90b277854d579933abbb31b2476920d9f9bb5fd1b9991ec25164dd2325c88feeb6db35225390b76a86fea5fc43d23
|
7
|
+
data.tar.gz: 4cd5dff63120570a7ecfe3bb5da66fab1d2918c41f5b7c1334fc6e31d7048ada30678a9b8e17cd96527420bed0346c522d4165b5e23c9b6fed3ea479e54afe17
|
data/.gitignore
CHANGED
data/.travis.yml
CHANGED
@@ -5,33 +5,83 @@ gemfile: fixture/gemfile
|
|
5
5
|
rvm:
|
6
6
|
- 2.2.6
|
7
7
|
- 2.3.3
|
8
|
+
- 2.6.7
|
9
|
+
- 2.7.3
|
8
10
|
|
9
11
|
env:
|
10
|
-
- CHEF_VERSION=master
|
11
|
-
- CHEF_VERSION=
|
12
|
-
- CHEF_VERSION=
|
13
|
-
- CHEF_VERSION=12.
|
14
|
-
- CHEF_VERSION=12.
|
15
|
-
- CHEF_VERSION=12.1.
|
16
|
-
- CHEF_VERSION=12.0.
|
17
|
-
- CHEF_VERSION=
|
18
|
-
- CHEF_VERSION=
|
19
|
-
- CHEF_VERSION=
|
20
|
-
- CHEF_VERSION=11.12.
|
21
|
-
- CHEF_VERSION=11.
|
12
|
+
- CHEF_VERSION=master EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
13
|
+
- CHEF_VERSION=16.13.16 EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
14
|
+
- CHEF_VERSION=15.17.4 EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
15
|
+
- CHEF_VERSION=12.6.0 EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
16
|
+
- CHEF_VERSION=12.5.1 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
17
|
+
- CHEF_VERSION=12.4.1 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
18
|
+
- CHEF_VERSION=12.3.0 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
19
|
+
- CHEF_VERSION=12.2.1 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
20
|
+
- CHEF_VERSION=12.1.2 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
21
|
+
- CHEF_VERSION=12.0.3 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
22
|
+
- CHEF_VERSION=11.18.12 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
23
|
+
- CHEF_VERSION=11.16.4 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
24
|
+
- CHEF_VERSION=11.14.6 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
25
|
+
- CHEF_VERSION=11.12.8 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
26
|
+
- CHEF_VERSION=11.10.4 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
22
27
|
|
23
28
|
matrix:
|
24
29
|
fast_finish: true
|
25
30
|
exclude:
|
26
|
-
- env: CHEF_VERSION=11.12.8
|
31
|
+
- env: CHEF_VERSION=11.12.8 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
27
32
|
rvm: 2.3.3
|
28
|
-
- env: CHEF_VERSION=11.10.4
|
33
|
+
- env: CHEF_VERSION=11.10.4 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
29
34
|
rvm: 2.3.3
|
35
|
+
# As of May 28 2021, chef/chef master requires 2.7 or higher
|
36
|
+
- env: CHEF_VERSION=master EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
37
|
+
rvm: 2.2.6
|
38
|
+
- env: CHEF_VERSION=master EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
39
|
+
rvm: 2.3.3
|
40
|
+
- env: CHEF_VERSION=master EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
41
|
+
rvm: 2.6.7
|
42
|
+
# Newer Chef does not work with old Ruby
|
43
|
+
- env: CHEF_VERSION=16.13.16 EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
44
|
+
rvm: 2.2.6
|
45
|
+
- env: CHEF_VERSION=15.17.4 EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
46
|
+
rvm: 2.2.6
|
47
|
+
- env: CHEF_VERSION=16.13.16 EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
48
|
+
rvm: 2.3.3
|
49
|
+
- env: CHEF_VERSION=15.17.4 EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
50
|
+
rvm: 2.3.3
|
51
|
+
# Old Chef bundles old json package incompatible with newer Ruby
|
52
|
+
- env: CHEF_VERSION=12.1.2 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
53
|
+
rvm: 2.6.7
|
54
|
+
- env: CHEF_VERSION=12.1.2 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
55
|
+
rvm: 2.7.3
|
56
|
+
- env: CHEF_VERSION=12.0.3 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
57
|
+
rvm: 2.6.7
|
58
|
+
- env: CHEF_VERSION=12.0.3 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
59
|
+
rvm: 2.7.3
|
60
|
+
- env: CHEF_VERSION=11.18.12 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
61
|
+
rvm: 2.6.7
|
62
|
+
- env: CHEF_VERSION=11.18.12 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
63
|
+
rvm: 2.7.3
|
64
|
+
- env: CHEF_VERSION=11.16.4 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
65
|
+
rvm: 2.6.7
|
66
|
+
- env: CHEF_VERSION=11.16.4 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
67
|
+
rvm: 2.7.3
|
68
|
+
- env: CHEF_VERSION=11.14.6 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
69
|
+
rvm: 2.6.7
|
70
|
+
- env: CHEF_VERSION=11.14.6 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
71
|
+
rvm: 2.7.3
|
72
|
+
- env: CHEF_VERSION=11.12.8 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
73
|
+
rvm: 2.6.7
|
74
|
+
- env: CHEF_VERSION=11.12.8 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
75
|
+
rvm: 2.7.3
|
76
|
+
- env: CHEF_VERSION=11.10.4 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
77
|
+
rvm: 2.6.7
|
78
|
+
- env: CHEF_VERSION=11.10.4 EXPECTED_FILE=README-expected_legacy.md METADATA=metadata_legacy.rb
|
79
|
+
rvm: 2.7.3
|
30
80
|
|
31
81
|
allow_failures:
|
32
|
-
- env: CHEF_VERSION=master
|
82
|
+
- env: CHEF_VERSION=master EXPECTED_FILE=README-expected.md METADATA=metadata.rb
|
33
83
|
|
34
84
|
script:
|
35
85
|
- cd fixture
|
36
|
-
- bundle exec knife cookbook doc . -o README-generated.md -c knife.rb
|
37
|
-
- diff
|
86
|
+
- bundle exec knife cookbook doc . -o README-generated.md -c knife.rb --metadata $METADATA
|
87
|
+
- diff $EXPECTED_FILE README-generated.md && rm README-generated.md
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,19 @@
|
|
1
|
+
# v0.31.0 (Feb 7 2022)
|
2
|
+
|
3
|
+
* Prettify Chef version constraints.
|
4
|
+
|
5
|
+
# v0.30.0 (Mar 19 2021)
|
6
|
+
|
7
|
+
* Support a space after # in custom resource. Submitted by Tomoya Kabe.
|
8
|
+
|
9
|
+
# v0.29.0 (Jun 26 2020)
|
10
|
+
|
11
|
+
* Extract descriptions from `libraries/*.rb`. Submitted by Joe Nuspl.
|
12
|
+
|
13
|
+
# v0.28.0 (Jun 11 2020)
|
14
|
+
|
15
|
+
* If `Berksfile` exists, add source_url links to cookbooks. Submitted by Joe Nuspl.
|
16
|
+
|
1
17
|
# v0.27.0 (Jun 20 2019)
|
2
18
|
|
3
19
|
* Add support for Chef 15. Submitted by grozan.
|
data/Rakefile
CHANGED
@@ -4,3 +4,12 @@ require 'rake/clean'
|
|
4
4
|
task :default => :build
|
5
5
|
|
6
6
|
CLEAN.include 'pkg'
|
7
|
+
|
8
|
+
task :test => :install
|
9
|
+
task :test do
|
10
|
+
sh <<SCRIPT
|
11
|
+
cd fixture
|
12
|
+
knife cookbook doc . -o README-generated.md -c knife.rb
|
13
|
+
diff -u README-expected.md README-generated.md && rm README-generated.md
|
14
|
+
SCRIPT
|
15
|
+
end
|
data/fixture/README-expected.md
CHANGED
@@ -9,7 +9,8 @@
|
|
9
9
|
|
10
10
|
## Chef Client:
|
11
11
|
|
12
|
-
*
|
12
|
+
* chef (>= 14.0, < 16.0)
|
13
|
+
* chef (= 12.0)
|
13
14
|
|
14
15
|
## Platform:
|
15
16
|
|
@@ -36,6 +37,7 @@ MyApp Admin Group: The group allowed to manage MyApp.
|
|
36
37
|
# Resources
|
37
38
|
|
38
39
|
* [fixture](#fixture) - This resource is awesome.
|
40
|
+
* [fixture_space](#fixture_space) - This resource is spacial.
|
39
41
|
|
40
42
|
## fixture
|
41
43
|
|
@@ -50,6 +52,24 @@ This resource is awesome.
|
|
50
52
|
- my_attribute: This is an attribute. Defaults to <code>"a default value"</code>.
|
51
53
|
- my_property: This is a property. Defaults to <code>"another default value"</code>.
|
52
54
|
|
55
|
+
## fixture_space
|
56
|
+
|
57
|
+
This resource is spacial.
|
58
|
+
|
59
|
+
### Actions
|
60
|
+
|
61
|
+
- stuff: Inserts spaces. Default action.
|
62
|
+
|
63
|
+
### Attribute Parameters
|
64
|
+
|
65
|
+
- my_attribute: This is an attribute. Defaults to <code>"a default value"</code>.
|
66
|
+
- my_property: This is a property. Defaults to <code>"another default value"</code>.
|
67
|
+
|
68
|
+
# Libraries
|
69
|
+
|
70
|
+
## stooges()
|
71
|
+
Returns `['Moe', 'Larry', 'Curly']`
|
72
|
+
|
53
73
|
# Credits
|
54
74
|
|
55
75
|
* Mathias Lafeldt
|
@@ -0,0 +1,75 @@
|
|
1
|
+
# Description
|
2
|
+
|
3
|
+
# My Cookbook Readme
|
4
|
+
|
5
|
+
**`knife cookbook doc .` _rocks_**
|
6
|
+
|
7
|
+
# Requirements
|
8
|
+
|
9
|
+
|
10
|
+
## Chef Client:
|
11
|
+
|
12
|
+
*No Chef versions defined*
|
13
|
+
|
14
|
+
## Platform:
|
15
|
+
|
16
|
+
* cookbook-authors
|
17
|
+
|
18
|
+
## Cookbooks:
|
19
|
+
|
20
|
+
* upon-magic
|
21
|
+
|
22
|
+
# Attributes
|
23
|
+
|
24
|
+
* `node['knife']['cookbook']['doc']` - Defaults to `successful automation`.
|
25
|
+
|
26
|
+
# Recipes
|
27
|
+
|
28
|
+
* [fixture::default](#fixturedefault) - The recipe is awesome.
|
29
|
+
|
30
|
+
## fixture::default
|
31
|
+
|
32
|
+
The recipe is awesome. It does thing 1, thing 2 and thing 3!
|
33
|
+
|
34
|
+
MyApp Admin Group: The group allowed to manage MyApp.
|
35
|
+
|
36
|
+
# Resources
|
37
|
+
|
38
|
+
* [fixture](#fixture) - This resource is awesome.
|
39
|
+
* [fixture_space](#fixture_space) - This resource is spacial.
|
40
|
+
|
41
|
+
## fixture
|
42
|
+
|
43
|
+
This resource is awesome.
|
44
|
+
|
45
|
+
### Actions
|
46
|
+
|
47
|
+
- stuff: Does awesome things. Default action.
|
48
|
+
|
49
|
+
### Attribute Parameters
|
50
|
+
|
51
|
+
- my_attribute: This is an attribute. Defaults to <code>"a default value"</code>.
|
52
|
+
- my_property: This is a property. Defaults to <code>"another default value"</code>.
|
53
|
+
|
54
|
+
## fixture_space
|
55
|
+
|
56
|
+
This resource is spacial.
|
57
|
+
|
58
|
+
### Actions
|
59
|
+
|
60
|
+
- stuff: Inserts spaces. Default action.
|
61
|
+
|
62
|
+
### Attribute Parameters
|
63
|
+
|
64
|
+
- my_attribute: This is an attribute. Defaults to <code>"a default value"</code>.
|
65
|
+
- my_property: This is a property. Defaults to <code>"another default value"</code>.
|
66
|
+
|
67
|
+
# Libraries
|
68
|
+
|
69
|
+
## stooges()
|
70
|
+
Returns `['Moe', 'Larry', 'Curly']`
|
71
|
+
|
72
|
+
# Credits
|
73
|
+
|
74
|
+
* Mathias Lafeldt
|
75
|
+
* Peter Donald
|
data/fixture/gemfile
CHANGED
data/fixture/metadata.rb
CHANGED
@@ -5,6 +5,8 @@ license 'MIT'
|
|
5
5
|
description 'Installs/Configures fixture'
|
6
6
|
long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
|
7
7
|
version '0.1.0'
|
8
|
+
chef_version '>= 14.0', '< 16.0'
|
9
|
+
chef_version '= 12.0'
|
8
10
|
|
9
11
|
supports 'cookbook-authors'
|
10
12
|
depends 'upon-magic'
|
@@ -0,0 +1,10 @@
|
|
1
|
+
name 'fixture'
|
2
|
+
maintainer 'A Cookbook Author'
|
3
|
+
maintainer_email 'author@example.com'
|
4
|
+
license 'MIT'
|
5
|
+
description 'Installs/Configures fixture'
|
6
|
+
long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
|
7
|
+
version '0.1.0'
|
8
|
+
|
9
|
+
supports 'cookbook-authors'
|
10
|
+
depends 'upon-magic'
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# <
|
2
|
+
# This resource is spacial.
|
3
|
+
#
|
4
|
+
# @action stuff Inserts spaces.
|
5
|
+
# >
|
6
|
+
|
7
|
+
default_action :stuff
|
8
|
+
|
9
|
+
# <> @attribute my_attribute This is an attribute.
|
10
|
+
attribute :my_attribute, default: 'a default value'
|
11
|
+
|
12
|
+
# <> @property my_property This is a property.
|
13
|
+
property :my_property, default: 'another default value'
|
@@ -157,6 +157,13 @@
|
|
157
157
|
<%= resource.top_level_description(key) -%>
|
158
158
|
<% end -%>
|
159
159
|
|
160
|
+
<% end -%>
|
161
|
+
<% end -%>
|
162
|
+
<% unless libraries.empty? -%>
|
163
|
+
# Libraries
|
164
|
+
<% libraries.each do |lib| -%>
|
165
|
+
|
166
|
+
<%= lib.descriptions %>
|
160
167
|
<% end -%>
|
161
168
|
<% end -%>
|
162
169
|
<% fragments.keys.select {|k|k != 'overview' && k != 'credit' && k != 'requirements'}.each do |key| -%>
|
@@ -9,6 +9,7 @@ module KnifeCookbookDoc
|
|
9
9
|
require 'knife_cookbook_doc/base_model'
|
10
10
|
require 'knife_cookbook_doc/documenting_lwrp_base'
|
11
11
|
require 'knife_cookbook_doc/definitions_model'
|
12
|
+
require 'knife_cookbook_doc/libraries_model'
|
12
13
|
require 'knife_cookbook_doc/readme_model'
|
13
14
|
require 'knife_cookbook_doc/recipe_model'
|
14
15
|
require 'knife_cookbook_doc/resource_model'
|
@@ -42,6 +43,11 @@ module KnifeCookbookDoc
|
|
42
43
|
:default => false,
|
43
44
|
:description => 'Ignore attributes without documetation'
|
44
45
|
|
46
|
+
option :metadata,
|
47
|
+
:long => '--metadata FILE',
|
48
|
+
:default => 'metadata.rb',
|
49
|
+
:description => 'metadata.rb path'
|
50
|
+
|
45
51
|
def run
|
46
52
|
unless (cookbook_dir = name_args.first)
|
47
53
|
ui.fatal 'Please provide cookbook directory as an argument'
|
@@ -6,6 +6,7 @@ require 'rake/tasklib'
|
|
6
6
|
require 'knife_cookbook_doc/base_model'
|
7
7
|
require 'knife_cookbook_doc/documenting_lwrp_base'
|
8
8
|
require 'knife_cookbook_doc/definitions_model'
|
9
|
+
require 'knife_cookbook_doc/libraries_model'
|
9
10
|
require 'knife_cookbook_doc/readme_model'
|
10
11
|
require 'knife_cookbook_doc/recipe_model'
|
11
12
|
require 'knife_cookbook_doc/resource_model'
|
@@ -1,11 +1,19 @@
|
|
1
|
+
begin
|
2
|
+
require 'berkshelf'
|
3
|
+
rescue LoadError
|
4
|
+
# won't be able to get :source_url for dependent cookbooks
|
5
|
+
end
|
6
|
+
|
1
7
|
module KnifeCookbookDoc
|
2
8
|
class ReadmeModel
|
3
9
|
DEFAULT_CONSTRAINT = ">= 0.0.0".freeze
|
4
10
|
|
11
|
+
attr_reader :libraries
|
12
|
+
|
5
13
|
def initialize(cookbook_dir, config)
|
6
14
|
|
7
15
|
@metadata = Chef::Cookbook::Metadata.new
|
8
|
-
@metadata.from_file("#{cookbook_dir}
|
16
|
+
@metadata.from_file("#{cookbook_dir}/#{config[:metadata]}")
|
9
17
|
|
10
18
|
if (!@metadata.attributes.empty? rescue false)
|
11
19
|
@attributes = @metadata.attributes.map do |attr, options|
|
@@ -22,6 +30,10 @@ module KnifeCookbookDoc
|
|
22
30
|
end
|
23
31
|
end
|
24
32
|
|
33
|
+
@libraries = Dir["#{cookbook_dir}/libraries/*.rb"].sort.map do |path|
|
34
|
+
LibrariesModel.new(@metadata.name, path)
|
35
|
+
end
|
36
|
+
|
25
37
|
@resources = []
|
26
38
|
Dir["#{cookbook_dir}/resources/*.rb"].sort.each do |resource_filename|
|
27
39
|
@resources << ResourceModel.new(@metadata.name, resource_filename)
|
@@ -98,8 +110,9 @@ module KnifeCookbookDoc
|
|
98
110
|
|
99
111
|
def chef_versions
|
100
112
|
if @metadata.methods.include?(:chef_version)
|
101
|
-
@metadata.chef_versions.map do |chef_version
|
102
|
-
|
113
|
+
@metadata.chef_versions.map do |chef_version|
|
114
|
+
constraints = chef_version.requirements_list.join(', ')
|
115
|
+
format_constraint(chef_version.name, constraints)
|
103
116
|
end
|
104
117
|
else
|
105
118
|
[]
|
@@ -172,7 +185,28 @@ module KnifeCookbookDoc
|
|
172
185
|
|
173
186
|
private
|
174
187
|
|
188
|
+
def source_url_from_berkshelf(name)
|
189
|
+
@source_url ||= begin
|
190
|
+
if File.exist?('Berksfile') && defined?(::Berkshelf)
|
191
|
+
::Berkshelf::Berksfile
|
192
|
+
.from_file('Berksfile')
|
193
|
+
.install
|
194
|
+
.map { |cb| [cb.cookbook_name, cb.metadata.source_url] }
|
195
|
+
.to_h
|
196
|
+
else
|
197
|
+
{}
|
198
|
+
end
|
199
|
+
end
|
200
|
+
@source_url[name]
|
201
|
+
end
|
202
|
+
|
175
203
|
def format_constraint(name, version)
|
204
|
+
url = source_url_from_berkshelf(name)
|
205
|
+
if !url.nil? && url.start_with?('http')
|
206
|
+
# git:// and ssh:// URLs are not browsable
|
207
|
+
name = "[#{name}](#{url})"
|
208
|
+
end
|
209
|
+
|
176
210
|
if @constraints && version != DEFAULT_CONSTRAINT
|
177
211
|
"#{name} (#{version})"
|
178
212
|
else
|
@@ -98,13 +98,13 @@ module KnifeCookbookDoc
|
|
98
98
|
resource_class.resource_name = filename_to_qualified_string(cookbook_name, filename)
|
99
99
|
resource_class.run_context = nil
|
100
100
|
resource_data = IO.read(filename)
|
101
|
-
resource_data = resource_data.gsub(/^=begin *\n
|
101
|
+
resource_data = resource_data.gsub(/^=begin *\n *\# ?\<\n(.*?)^ *\# ?\>\n=end *\n/m) do
|
102
102
|
"desc <<DOCO\n#{$1}\nDOCO\n"
|
103
103
|
end
|
104
|
-
resource_data = resource_data.gsub(/^
|
104
|
+
resource_data = resource_data.gsub(/^ *\# ?\<\n(.*?)^ *\# ?\>\n/m) do
|
105
105
|
"desc <<DOCO\n#{$1.gsub(/^ *\# ?/, '')}\nDOCO\n"
|
106
106
|
end
|
107
|
-
resource_data = resource_data.gsub(/^
|
107
|
+
resource_data = resource_data.gsub(/^ *\# ?\<\> (.*?)$/) do
|
108
108
|
"desc #{$1.inspect}\n"
|
109
109
|
end
|
110
110
|
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: knife-cookbook-doc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.31.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Mathias Lafeldt
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date:
|
12
|
+
date: 2022-02-07 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: chef
|
@@ -88,15 +88,19 @@ files:
|
|
88
88
|
- Rakefile
|
89
89
|
- fixture/CHANGELOG.md
|
90
90
|
- fixture/README-expected.md
|
91
|
+
- fixture/README-expected_legacy.md
|
91
92
|
- fixture/README.md
|
92
93
|
- fixture/attributes/default.rb
|
93
94
|
- fixture/doc/credit.md
|
94
95
|
- fixture/doc/overview.md
|
95
96
|
- fixture/gemfile
|
96
97
|
- fixture/knife.rb
|
98
|
+
- fixture/libraries/default.rb
|
97
99
|
- fixture/metadata.rb
|
100
|
+
- fixture/metadata_legacy.rb
|
98
101
|
- fixture/recipes/default.rb
|
99
102
|
- fixture/resources/default.rb
|
103
|
+
- fixture/resources/space.rb
|
100
104
|
- knife_cookbook_doc.gemspec
|
101
105
|
- lib/chef/knife/README.md.erb
|
102
106
|
- lib/chef/knife/cookbook_doc.rb
|
@@ -104,6 +108,7 @@ files:
|
|
104
108
|
- lib/knife_cookbook_doc/base_model.rb
|
105
109
|
- lib/knife_cookbook_doc/definitions_model.rb
|
106
110
|
- lib/knife_cookbook_doc/documenting_lwrp_base.rb
|
111
|
+
- lib/knife_cookbook_doc/libraries_model.rb
|
107
112
|
- lib/knife_cookbook_doc/rake_task.rb
|
108
113
|
- lib/knife_cookbook_doc/readme_model.rb
|
109
114
|
- lib/knife_cookbook_doc/recipe_model.rb
|
@@ -130,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
130
135
|
- !ruby/object:Gem::Version
|
131
136
|
version: '0'
|
132
137
|
requirements: []
|
133
|
-
|
134
|
-
rubygems_version: 2.5.1
|
138
|
+
rubygems_version: 3.1.2
|
135
139
|
signing_key:
|
136
140
|
specification_version: 4
|
137
141
|
summary: Knife plugin to generate README.md for a cookbook
|