chef_attrdoc 0.9.1 → 0.9.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +9 -9
- data/chef_attrdoc.gemspec +3 -3
- data/lib/chef_attrdoc/version.rb +1 -1
- metadata +6 -6
- /data/bin/{chef-attrdoc → chef_attrdoc} +0 -0
data/README.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
|
|
1
|
+
chef_attrdoc
|
|
2
2
|
============
|
|
3
|
-
[](http://badge.fury.io/rb/chef_attrdoc)
|
|
4
|
+
[](https://codeclimate.com/github/mapleoin/chef_attrdoc)
|
|
5
5
|
|
|
6
6
|
Extract documentation from chef cookbooks' attributes files and output it to the cookbook's README.md file.
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
`
|
|
9
|
+
`chef_attrdoc` groups attribute initialization lines together with the comments immediately above them. Any lines containing an attribute initialization which are not separated by an empty line are considered a group. The comment immediately above them is assumed to describe the group of attributes below. Groups of attribute initialization lines which are not immediately preceded by a comment line are ignored and will not show up in the output.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
chef_attrdoc currently ignores *TODO*, *XXX*, *NOTE* and *foodcritic* comments.
|
|
12
12
|
|
|
13
13
|
### Usage:
|
|
14
14
|
|
|
15
15
|
```
|
|
16
|
-
# gem install
|
|
17
|
-
#
|
|
16
|
+
# gem install chef_attrdoc
|
|
17
|
+
# chef_attrdoc ~/cookbooks/mycookbook
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
`
|
|
20
|
+
`chef_attrdoc` will try to find an Attributes heading in the README.md file in that directory and replace its contents with the generated `attributes/default.rb` documentation.
|
|
21
21
|
|
|
22
|
-
`
|
|
22
|
+
`chef_attrdoc` uses ruby's stdlib `ripper` module and so does not have any dependencies.
|
|
23
23
|
|
|
24
24
|
### Examples
|
|
25
25
|
|
data/chef_attrdoc.gemspec
CHANGED
|
@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
|
|
|
7
7
|
spec.name = "chef_attrdoc"
|
|
8
8
|
spec.version = ChefAttrdoc::VERSION
|
|
9
9
|
spec.authors = ["Ionuț Arțăriși"]
|
|
10
|
-
spec.email = ["
|
|
11
|
-
spec.description = %q{Generate README.md docs from
|
|
12
|
-
spec.summary = %q{Generate README.md docs from
|
|
10
|
+
spec.email = ["ionut@artarisi.eu"]
|
|
11
|
+
spec.description = %q{Generate README.md docs from Chef cookbook attributes files}
|
|
12
|
+
spec.summary = %q{Generate README.md docs from Chef cookbook attributes files}
|
|
13
13
|
spec.homepage = "https://github.com/mapleoin/chef_attrdoc"
|
|
14
14
|
spec.license = "Apache"
|
|
15
15
|
|
data/lib/chef_attrdoc/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: chef_attrdoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.9.
|
|
4
|
+
version: 0.9.2
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -11,11 +11,11 @@ bindir: bin
|
|
|
11
11
|
cert_chain: []
|
|
12
12
|
date: 2014-06-26 00:00:00.000000000 Z
|
|
13
13
|
dependencies: []
|
|
14
|
-
description: Generate README.md docs from
|
|
14
|
+
description: Generate README.md docs from Chef cookbook attributes files
|
|
15
15
|
email:
|
|
16
|
-
-
|
|
16
|
+
- ionut@artarisi.eu
|
|
17
17
|
executables:
|
|
18
|
-
-
|
|
18
|
+
- chef_attrdoc
|
|
19
19
|
extensions: []
|
|
20
20
|
extra_rdoc_files: []
|
|
21
21
|
files:
|
|
@@ -23,7 +23,7 @@ files:
|
|
|
23
23
|
- LICENSE
|
|
24
24
|
- README.md
|
|
25
25
|
- Rakefile
|
|
26
|
-
- bin/
|
|
26
|
+
- bin/chef_attrdoc
|
|
27
27
|
- chef_attrdoc.gemspec
|
|
28
28
|
- lib/chef_attrdoc.rb
|
|
29
29
|
- lib/chef_attrdoc/version.rb
|
|
@@ -53,7 +53,7 @@ rubyforge_project:
|
|
|
53
53
|
rubygems_version: 1.8.23
|
|
54
54
|
signing_key:
|
|
55
55
|
specification_version: 3
|
|
56
|
-
summary: Generate README.md docs from
|
|
56
|
+
summary: Generate README.md docs from Chef cookbook attributes files
|
|
57
57
|
test_files:
|
|
58
58
|
- spec/chef_attrdoc_spec.rb
|
|
59
59
|
- spec/spec_helper.rb
|
|
File without changes
|