knife-cookbook-doc 0.24.2 → 0.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +1 -0
- data/CHANGELOG.md +0 -4
- data/CONTRIBUTING.md +10 -27
- data/fixture/README-expected.md +0 -5
- data/lib/chef/knife/README.md.erb +0 -11
- data/lib/knife_cookbook_doc/readme_model.rb +0 -10
- data/lib/knife_cookbook_doc/version.rb +1 -1
- metadata +2 -3
- data/.github/ISSUE_TEMPLATE.md +0 -45
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bbbc143a652e8129c85a65adcf70802ae67bcbd0
|
4
|
+
data.tar.gz: 1630f21c869c7a02da034b4fc23057e0f16f3121
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 26328bdf572cfc2b4585ce9ba1164420f3e530f225be7cbbfc37b4370c9dc4ce8a9dbe037b14d1968f948878602661ce48f5d9251bda5b720e69bcd7edb10259
|
7
|
+
data.tar.gz: 92b78ebc35f1e540e42b2b167149d529cdf3d42bf81ac94aec3f2b4c63fcb36088b50a47a11b14f2868df4d0cbcbaf9d512990966cef047cd94267dcdab2ce38
|
data/.travis.yml
CHANGED
data/CHANGELOG.md
CHANGED
data/CONTRIBUTING.md
CHANGED
@@ -1,34 +1,19 @@
|
|
1
1
|
# How to Contribute
|
2
2
|
|
3
|
-
|
4
|
-
what makes open source great. There are just a few small guidelines you need to follow.
|
3
|
+
Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
|
5
4
|
|
6
|
-
|
5
|
+
* Fork it
|
6
|
+
* Create your feature branch (`git checkout -b my-new-feature`)
|
7
|
+
* Commit your changes (`git commit -am 'Add some feature'`)
|
8
|
+
* Push to the branch (`git push origin my-new-feature`)
|
9
|
+
* Create new Pull Request
|
7
10
|
|
8
|
-
|
9
|
-
|
10
|
-
## Submitting code via Pull Requests
|
11
|
-
|
12
|
-
- We follow the [Github Pull Request Model](https://help.github.com/articles/about-pull-requests/) for
|
13
|
-
all contributions.
|
14
|
-
- For large bodies of work, we recommend creating an issue outlining the feature that you wish to build,
|
15
|
-
and describing how it will be implemented. This gives a chance for review to happen early, and ensures
|
16
|
-
no wasted effort occurs.
|
17
|
-
- All submissions, will require review before being merged.
|
18
|
-
- Finally - *Thanks* for considering submitting code to the project!
|
19
|
-
|
20
|
-
## Formatting
|
21
|
-
|
22
|
-
When submitting pull requests, make sure to do the following:
|
23
|
-
|
24
|
-
- Maintain the same code style as the rest of the project.
|
25
|
-
- Remove trailing whitespace. Many editors will do this automatically.
|
26
|
-
- Ensure any new files have [a trailing newline](https://stackoverflow.com/questions/5813311/no-newline-at-end-of-file)
|
11
|
+
Pester us if we don't get your Pull Requests merged in a timely fashion. :)
|
27
12
|
|
28
13
|
## How to speed the merging of pull requests
|
29
14
|
|
30
|
-
* Describe your changes in the CHANGELOG.
|
31
|
-
* Give yourself some credit in the appropriate place (usually the CHANGELOG
|
15
|
+
* Describe your changes in the CHANGELOG.
|
16
|
+
* Give yourself some credit in the appropriate place (usually the CHANGELOG).
|
32
17
|
* Make commits of logical units.
|
33
18
|
* Ensure your commit messages help others understand what you are doing and why.
|
34
19
|
* Check for unnecessary whitespace with `git diff --check` before committing.
|
@@ -38,6 +23,4 @@ When submitting pull requests, make sure to do the following:
|
|
38
23
|
## Additional Resources
|
39
24
|
|
40
25
|
* [General GitHub documentation](http://help.github.com/)
|
41
|
-
* [
|
42
|
-
Great way to make sure your Pull Requests get accepted.
|
43
|
-
* [An Open Source Etiquette Guidebook](https://css-tricks.com/open-source-etiquette-guidebook/#article-header-id-1)
|
26
|
+
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
|
data/fixture/README-expected.md
CHANGED
@@ -12,17 +12,6 @@
|
|
12
12
|
<%= fragments['requirements'] -%>
|
13
13
|
|
14
14
|
<% end -%>
|
15
|
-
|
16
|
-
## Chef Client:
|
17
|
-
|
18
|
-
<% unless chef_versions.empty? %>
|
19
|
-
<% chef_versions.each do |chef_version| %>
|
20
|
-
* <%= chef_version %>
|
21
|
-
<% end %>
|
22
|
-
<% else %>
|
23
|
-
*No Chef versions defined*
|
24
|
-
<% end %>
|
25
|
-
|
26
15
|
## Platform:
|
27
16
|
|
28
17
|
<% unless platforms.empty? %>
|
@@ -96,16 +96,6 @@ module KnifeCookbookDoc
|
|
96
96
|
end
|
97
97
|
end
|
98
98
|
|
99
|
-
def chef_versions
|
100
|
-
if @metadata.methods.include?(:chef_version)
|
101
|
-
@metadata.chef_versions.map do |chef_version, version|
|
102
|
-
format_constraint(chef_version, version)
|
103
|
-
end
|
104
|
-
else
|
105
|
-
[]
|
106
|
-
end
|
107
|
-
end
|
108
|
-
|
109
99
|
def dependencies
|
110
100
|
@metadata.dependencies.map do |cookbook, version|
|
111
101
|
format_constraint(cookbook, version)
|
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.25.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: 2018-
|
12
|
+
date: 2018-03-07 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: chef
|
@@ -76,7 +76,6 @@ extensions: []
|
|
76
76
|
extra_rdoc_files: []
|
77
77
|
files:
|
78
78
|
- ".gitattributes"
|
79
|
-
- ".github/ISSUE_TEMPLATE.md"
|
80
79
|
- ".gitignore"
|
81
80
|
- ".travis.yml"
|
82
81
|
- CHANGELOG.md
|
data/.github/ISSUE_TEMPLATE.md
DELETED
@@ -1,45 +0,0 @@
|
|
1
|
-
<!--
|
2
|
-
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
|
3
|
-
Please make sure that you are familiar with and follow the Code of Conduct for
|
4
|
-
this project (found in the CODE_OF_CONDUCT.md file).
|
5
|
-
|
6
|
-
Please fill out this template with all the relevant information so we can
|
7
|
-
understand what's going on and fix the issue.
|
8
|
-
|
9
|
-
I may ask you to submit the fix (after giving some direction).
|
10
|
-
-->
|
11
|
-
|
12
|
-
Environment:
|
13
|
-
|
14
|
-
<!--
|
15
|
-
Please provide the version of this project where the issue occurred as well as the
|
16
|
-
versions of other environmental factors. This could be virtual machine version, os
|
17
|
-
version, browser version etc.
|
18
|
-
-->
|
19
|
-
|
20
|
-
Relevant code or config:
|
21
|
-
|
22
|
-
```
|
23
|
-
|
24
|
-
```
|
25
|
-
|
26
|
-
What you did:
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
What happened:
|
31
|
-
|
32
|
-
<!-- Please provide the full error message/screenshots/anything -->
|
33
|
-
|
34
|
-
Reproduction repository:
|
35
|
-
|
36
|
-
<!--
|
37
|
-
If possible, please create a repository that reproduces the issue with the
|
38
|
-
minimal amount of code possible.
|
39
|
-
-->
|
40
|
-
|
41
|
-
Problem description:
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
Suggested solution:
|