README.md in puppet-lint-absolute_classname-check-1.0.0 vs README.md in puppet-lint-absolute_classname-check-2.0.0
- old
+ new
@@ -3,11 +3,10 @@
[![Build Status](https://img.shields.io/travis/voxpupuli/puppet-lint-absolute_classname-check.svg)](https://travis-ci.org/voxpupuli/puppet-lint-absolute_classname-check)
[![Gem Version](https://img.shields.io/gem/v/puppet-lint-absolute_classname-check.svg)](https://rubygems.org/gems/puppet-lint-absolute_classname-check)
[![Gem Downloads](https://img.shields.io/gem/dt/puppet-lint-absolute_classname-check.svg)](https://rubygems.org/gems/puppet-lint-absolute_classname-check)
[![Coverage Status](https://img.shields.io/coveralls/voxpupuli/puppet-lint-absolute_classname-check.svg)](https://coveralls.io/r/voxpupuli/puppet-lint-absolute_classname-check?branch=master)
-[![Gemnasium](https://img.shields.io/gemnasium/voxpupuli/puppet-lint-absolute_classname-check.svg)](https://gemnasium.com/voxpupuli/puppet-lint-absolute_classname-check)
[![Donated by Camptocamp](https://img.shields.io/badge/donated%20by-camptocamp-fb7047.svg)](#transfer-notice)
A puppet-lint plugin to check that classes are included by their absolute name.
@@ -37,32 +36,24 @@
## Checks
### Relative class name inclusion
-Including a class by a relative name might lead to unexpected results [in Puppet 3](https://docs.puppet.com/puppet/3/lang_namespaces.html#relative-name-lookup-and-incorrect-name-resolution).
+Including a class by a relative name might lead to unexpected results [in Puppet 3](https://docs.puppet.com/puppet/3/lang_namespaces.html#relative-name-lookup-and-incorrect-name-resolution). That's why a lot of manifests explicitly include by the absolute name. Since Puppet 4 names are always absolute and this is no longer needed. This lint check helps to clean up your manifests.
#### What you have done
```puppet
-include foobar
+include ::foobar
```
#### What you should have done
```puppet
-include ::foobar
+include foobar
```
-#### Reverse this check
-
-This check can be reversed to check for Puppet > 4.
-
-```ruby
-PuppetLint.configuration.absolute_classname_reverse = true
-```
-
#### Disabling the check
To disable this check, you can add `--no-relative_classname_inclusion-check` to your puppet-lint command line.
```shell
@@ -85,10 +76,9 @@
## Release information
To make a new release, please do:
* Update the version in the `puppet-lint-absolute_classname-check.gemspec` file
-* Update the version in the Rakefile
* Install gems with `bundle install --with release --path .vendor`
* generate the changelog with `bundle exec rake changelog`
* Create a PR with it
* After it got merged, push a tag. Travis will do the actual release