README.md in puppet-lint-absolute_classname-check-0.2.5 vs README.md in puppet-lint-absolute_classname-check-1.0.0
- old
+ new
@@ -8,10 +8,21 @@
[](https://gemnasium.com/voxpupuli/puppet-lint-absolute_classname-check)
[](#transfer-notice)
A puppet-lint plugin to check that classes are included by their absolute name.
+
+## Table of contents
+
+* [Installing](#installing)
+ * [From the command line](#from-the-command-line)
+ * [In a Gemfile](#in-a-gemfile)
+* [Checks](#checks)
+ * [Relative class name inclusion](#relative-class-name-inclusion)
+* [Transfer notice](#transfer-notice)
+* [Release Informaion](#release-information)
+
## Installing
### From the command line
```shell
@@ -26,11 +37,11 @@
## 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). This plugin is **not** recommended for use with Puppet code that has dropped support for Puppet 3 (EOL 20161231).
+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).
#### What you have done
```puppet
include foobar
@@ -40,10 +51,18 @@
```puppet
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
@@ -61,5 +80,15 @@
This plugin was originally authored by [Camptocamp](http://www.camptocamp.com).
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 instead of Camptocamp.
Previously: https://github.com/camptocamp/puppet-lint-absolute_classname-check
+
+## 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