README.md in puppet-lint-param-docs-1.7.4 vs README.md in puppet-lint-param-docs-1.7.5
- old
+ new
@@ -1,7 +1,15 @@
# puppet-lint parameter documentation check
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-trailing_comma-check.svg)](https://github.com/voxpupuli/puppet-lint-trailing_comma-check/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/voxpupuli/puppet-lint-param-docs/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/puppet-lint-param-docs)
+[![Release](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-param-docs.svg)](https://rubygems.org/gems/puppet-lint-param-docs)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-param-docs.svg)](https://rubygems.org/gems/puppet-lint-param-docs)
+[![Donated by Dominic Cleal](https://img.shields.io/badge/donated%20by-Dominic%20Cleal-fb7047.svg)](#transfer-notice)
+
Adds a new puppet-lint check to verify all class and defined type parameters
have been documented.
Particularly useful with [kafo](https://github.com/theforeman/kafo), as its
default behaviour is to throw an error when a parameter is undocumented.
@@ -13,10 +21,25 @@
```ruby
gem 'puppet-lint-param-docs'
```
+This gem is not only available on rubygems, but also as [GitHub Package](https://github.com/voxpupuli/puppet-lint-param-docs/packages/)
+You can install it from GitHub like this:
+
+```
+$ gem install puppet-lint-param-docs --source "https://rubygems.pkg.github.com/voxpupuli"
+```
+
+Or in a Gemfile:
+
+```
+source "https://rubygems.pkg.github.com/voxpupuli" do
+ gem "puppet-lint-param-docs", "1.7.4"
+end
+```
+
## Usage
This plugin provides a new check to `puppet-lint`.
### parameter\_documentation
@@ -122,5 +145,27 @@
defines a new rake task (which runs after `lint`) specifically for the files
given in `config.pattern`.
The [Puppet Strings](#puppet_strings) `@api private` directive can also be used
to disable checks on that file.
+
+## Transfer Notice
+
+This plugin was originally authored by [Dominic Cleal](https://github.com/domcleal).
+The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred over, please fork and continue to contribute here.
+
+Previously: https://github.com/domcleal/puppet-lint-absolute_classname-check
+
+## License
+
+This gem is licensed under the MIT license.
+
+## Release information
+
+To make a new release, please do:
+* update the version in the gemspec file
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages