knife-cookbook-doc 0.25.0 → 0.25.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbbc143a652e8129c85a65adcf70802ae67bcbd0
-  data.tar.gz: 1630f21c869c7a02da034b4fc23057e0f16f3121
+  metadata.gz: 37887ab7ebaf12a054d994a6901d24d9e5783685
+  data.tar.gz: ed7ff7f97bc54ca4eaa390610632f8f1caedbdc0
 SHA512:
-  metadata.gz: 26328bdf572cfc2b4585ce9ba1164420f3e530f225be7cbbfc37b4370c9dc4ce8a9dbe037b14d1968f948878602661ce48f5d9251bda5b720e69bcd7edb10259
-  data.tar.gz: 92b78ebc35f1e540e42b2b167149d529cdf3d42bf81ac94aec3f2b4c63fcb36088b50a47a11b14f2868df4d0cbcbaf9d512990966cef047cd94267dcdab2ce38
+  metadata.gz: 641fea042b4c32c4ab37ce6c17074e6d697fa9c0bf2c0d776b11a349c34b327a18501a67e4bc809e7f149f437609e01569826d5ebbdd24cf7b12f95034d691ee
+  data.tar.gz: abd0276748d694e383a32bcf3ad8bc9ba500fe3f173a474a52017ca053c97bb70c68e064de7a9be470048d54a5bb049ded17571cfad467daf1d23e1ec26e6bd8

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,45 @@
+<!--
+Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
+Please make sure that you are familiar with and follow the Code of Conduct for
+this project (found in the CODE_OF_CONDUCT.md file).
+
+Please fill out this template with all the relevant information so we can
+understand what's going on and fix the issue.
+
+I may ask you to submit the fix (after giving some direction).
+-->
+
+Environment:
+
+<!--
+  Please provide the version of this project where the issue occurred as well as the
+  versions of other environmental factors. This could be virtual machine version, os
+  version, browser version etc.
+-->
+
+Relevant code or config:
+
+```
+
+```
+
+What you did:
+
+
+
+What happened:
+
+<!-- Please provide the full error message/screenshots/anything -->
+
+Reproduction repository:
+
+<!--
+If possible, please create a repository that reproduces the issue with the
+minimal amount of code possible.
+-->
+
+Problem description:
+
+
+
+Suggested solution:

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 cache: bundler
-sudo: false
 gemfile: fixture/gemfile
 
 rvm:

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v0.25.2 (Dec 18 2018)
+
+* Re-release gem with the appropriate version.
+
+# v0.24.2 (Dec 17 2018)
+
+* Add chef_versions support. Submitted by Nikolay Antsiferov.
+
+# v0.25.0 (Mar 7 2018)
+
+* Remove deprecated metadata for >= Chef 13. Submitted by Jamie Tanna.
+
 # v0.24.1 (Oct 2 2017)
 
 * Fix the markdown spacing for maintainer/source/issues URL. Submitted by Jamie Tanna.

data/CONTRIBUTING.md

@@ -1,19 +1,34 @@
 # How to Contribute
 
-Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+We'd love to accept your patches and contributions to this project. Pull requests are part of
+what makes open source great. There are just a few small guidelines you need to follow.
 
-* Fork it
-* Create your feature branch (`git checkout -b my-new-feature`)
-* Commit your changes (`git commit -am 'Add some feature'`)
-* Push to the branch (`git push origin my-new-feature`)
-* Create new Pull Request
+## Code of Conduct
 
-Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+Participation in this project comes under the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)
+
+## Submitting code via Pull Requests
+
+- We follow the [Github Pull Request Model](https://help.github.com/articles/about-pull-requests/) for
+  all contributions.
+- For large bodies of work, we recommend creating an issue outlining the feature that you wish to build,
+  and describing how it will be implemented. This gives a chance for review to happen early, and ensures
+  no wasted effort occurs.
+- All submissions, will require review before being merged.
+- Finally - *Thanks* for considering submitting code to the project!
+
+## Formatting
+
+When submitting pull requests, make sure to do the following:
+
+- Maintain the same code style as the rest of the project.
+- Remove trailing whitespace. Many editors will do this automatically.
+- Ensure any new files have [a trailing newline](https://stackoverflow.com/questions/5813311/no-newline-at-end-of-file)
 
 ## How to speed the merging of pull requests
 
-* Describe your changes in the CHANGELOG.
-* Give yourself some credit in the appropriate place (usually the CHANGELOG).
+* Describe your changes in the CHANGELOG.md (if present).
+* Give yourself some credit in the appropriate place (usually the CHANGELOG.md).
 * Make commits of logical units.
 * Ensure your commit messages help others understand what you are doing and why.
 * Check for unnecessary whitespace with `git diff --check` before committing.
@@ -23,4 +38,6 @@ Pester us if we don't get your Pull Requests merged in a timely fashion. :)
 ## Additional Resources
 
 * [General GitHub documentation](http://help.github.com/)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [How to write a good Git Commit message](https://chris.beams.io/posts/git-commit/) -
+  Great way to make sure your Pull Requests get accepted.
+* [An Open Source Etiquette Guidebook](https://css-tricks.com/open-source-etiquette-guidebook/#article-header-id-1)

data/fixture/README-expected.md

@@ -6,6 +6,11 @@
 
 # Requirements
 
+
+## Chef Client:
+
+*No Chef versions defined*
+
 ## Platform:
 
 * cookbook-authors

data/lib/chef/knife/README.md.erb

@@ -12,6 +12,17 @@
 <%= fragments['requirements'] -%>
 
 <% end -%>
+
+## Chef Client:
+
+<% unless chef_versions.empty? %>
+<% chef_versions.each do |chef_version| %>
+* <%= chef_version %>
+<% end %>
+<% else %>
+*No Chef versions defined*
+<% end %>
+
 ## Platform:
 
 <% unless platforms.empty? %>

data/lib/knife_cookbook_doc/readme_model.rb

@@ -96,6 +96,16 @@ module KnifeCookbookDoc
       end
     end
 
+    def chef_versions
+      if @metadata.methods.include?(:chef_version)
+        @metadata.chef_versions.map do |chef_version, version|
+          format_constraint(chef_version, version)
+        end
+      else
+        []
+      end
+    end
+
     def dependencies
       @metadata.dependencies.map do |cookbook, version|
         format_constraint(cookbook, version)

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.25.0'
+  VERSION = '0.25.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.25.2
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -76,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md