Close 0.1.0 release preparation

Version 0.1.0 release prep

.gitignore

@@ -13,10 +13,8 @@
 /Gemfile.lock
 /junit/
 /log/
-/log/
 /pkg/
 /spec/fixtures/manifests/
 /spec/fixtures/modules/
 /tmp/
 /vendor/
-

.travis.yml

@@ -1,46 +1,82 @@
 ---
 sudo: false
 dist: trusty
+
 language: ruby
 cache: bundler
+bundler_args: --without system_tests
+
 before_install:
   - bundle -v
   - rm Gemfile.lock || true
   - gem update --system
   - gem update bundler
   - gem --version
   - bundle -v
+
 script:
-  - 'bundle exec rake $CHECK'
+  - bundle exec rake $CHECK
 matrix:
   fast_finish: true
   include:
-    - rvm: 2.4.1
-      bundler_args: --without system_tests
-      env: PUPPET_GEM_VERSION="~> 5.0"
-      script:
-        - 'bundle exec rake $CHECK'
-        - 'bundle exec rake strings:generate'
+    # Check that the module performs for Puppet 4.9.x
     - rvm: 2.3.1
-      bundler_args: --without system_tests
-      env: PUPPET_GEM_VERSION="~> 4.9"
+      env: PUPPET_VERSION="~> 4.9" CHECK=spec
+
+    # Check for conflict markers, whitespace errors, and unwanted files
+    - rvm: 2.4.2
+      env: PUPPET_VERSION="~> 5.0"
+      script:
+        - git diff --check
+        - bundle exec rake check:dot_underscore check:test_file check:git_ignore check:symlinks
+
+    # Check for syntax and linting errors
+    - rvm: 2.4.2
+      env: PUPPET_VERSION="~> 5.0" CHECK='validate lint rubocop syntax:hiera'
+
+    # Check that the module performs for Puppet 5.0.x
+    - rvm: 2.4.2
+      env: PUPPET_VERSION="~> 5.0" CHECK=spec
+
+    # Generate the Puppet Strings documentation (YARD)
+    - rvm: 2.4.2
+      env: PUPPET_VERSION="~> 5.0" CHECK=strings:generate PUBLISH_PAGES=true
+
+    # Build the deployment artifact
+    - rvm: 2.4.2
+      env: PUPPET_VERSION="~> 5.0" CHECK=build DEPLOY_TO_FORGE=yes
+
 branches:
   only:
     - master
-    - /^v\d/
+    - /^\d+\.\d+\.\d+$/
+
 notifications:
   email: false
+
 deploy:
+  - provider: pages
+    skip_cleanup: true
+    github_token: $GITHUB_TOKEN
+    local_dir: docs
+    on:
+      branch: master
+      condition: $PUBLISH_PAGES = true
   - provider: puppetforge
+    skip_cleanup: true
     user: wwkimball
     password:
-      secure: "b+BnUaKYfP6TRHmQWfd63ROr4wxlRzQyzGfJt82PauYqGsYDRAfXpyfnhhuTRj5BqTuDT8PmRCTQKNnkrGJ4DAj0VPLtjuEcXuatjTQ1juSV24l3uPSG0l5WWUE3XQJB4R8FmbWUi/RVAXGQeqHmXIkohx8p5xXs16RgwxZB2e2ShdPbGDJwDuTePdkwNni5aBznhk/o0R4lu8+ezpgaHafD4brg0bSZ8obhZJfqTODQHD5lx2t0NM6hiigolSj5d/f0gN3ldzVFRiz7QO+H6o5GC+coDQib61u8vqi7Rs2ch3D8nrr64wKwG6zVvhjN/fAZdxAFVTwFAHcfB5s5s/hX16FvkhIMijK1ZPvjMO3keT/TlIYOn6G8cHDZMA7OAe7dgWuPXtm0vIm1ayHfjW8lSIftBrTJN+NGSIlTmDBLnHfuxh9IWgnx77rIzFi4ZvHqjptR5f9D/Jt/DkhKDiVtYIX1VoSEJj+UIHov0g04UVfctHPIhvDyyHQtRvaTu8BqevmkyAdelNxrtQSeue7LVFrMH8dqwFG5k5QIjL0ShvmQDz8rOvnlESpfsshN2SVYgkdhg8HCA3F4G/j35uUZkKQpynDYg9tQIn+Y2xX4awtiPX9xOC72fdLeeP9HRpPFAJwUorI5W7z6RB9mVNeNnpTEOCIbZyo1k71VnRM="
+      secure: "fes8KsRx6IEmmx1n00Q2gC9QgmCJwme11Xq9QXfZ+UsEpN4H6zLPCXtZqJIw6s+6\
+        WiqLy2AML0Fj8Coymag+u0DCh0kJCbLs7kChwFRoG5gSTzSIB4Z4WpnUiLAwnMwQbGEUTia\
+        yRdRBqrc7Rg+Moaa5QVy5CPfsZpBR9lHWvPkVMLpn3UiwSkL9LFRp9xqZFezaeLYTHxTnq6\
+        PTKM6ZlSnep92xzkAdK98mXMM7JtktctpAPCk4UPzFBY9rJaKVdoVQr+j7h710jdcrlL06j\
+        vMpQKK3z31PI9l50Wa9JGvdqouD+KNL/WaIxIZforBAroQ8PbP5wNAbKkYiws+KtrmdqvfE\
+        L7WSYdRrUOvvUBSJ2n9MwJakwLNmbw6iX/WOnStJp2+fcCjQGAgEk+mN3yoeF71F1HuMb89\
+        yqkvq9pYiG/SGAJbwaix94aEEBC06Do7hMeD8ua6RAYhmhlQXIUCoB+JvVJvGLvMtpxPQTq\
+        DXnNfdMGulKPt8BufNbcHO3fimND+R1svwabPAqDx91F91k49zqrlo7I0oZcHlAyNtxS8qt\
+        Bdbm2uldbotxfr+G9a3YjXkOySvxZr89tnoFppkQPvGJ6W6hj5OPxzKGBW0mIK0MH2UPX5i\
+        uK8OlKo0m0JuUnPotBMsAyNc0dW6NBgzE0Ulp9mASxzjIBtVihI="
     on:
       tags: true
       all_branches: true
-      condition: "$DEPLOY_TO_FORGE = yes"
-  - provider: pages
-    skip_cleanup: true
-    github_token: $GITHUB_TOKEN
-    on:
-      branch: master
+      condition: $DEPLOY_TO_FORGE = yes

Gemfile

@@ -24,6 +24,7 @@ ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments
 minor_version = ruby_version_segments[0..1].join('.')
 
 group :development do
+  gem 'coveralls',                                     require: false
   gem "fast_gettext", '1.1.0',                         require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0')
   gem "fast_gettext",                                  require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
   gem "json_pure", '<= 2.0.1',                         require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
@@ -32,6 +33,8 @@ group :development do
   gem "puppet-module-posix-dev-r#{minor_version}",     require: false, platforms: [:ruby]
   gem "puppet-module-win-default-r#{minor_version}",   require: false, platforms: [:mswin, :mingw, :x64_mingw]
   gem "puppet-module-win-dev-r#{minor_version}",       require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "puppet-strings", '1.1.0',                       require: false, platforms: [:ruby]
+  gem "rspec-puppet-yaml", '0.1.1',                    require: false, platforms: [:ruby]
 end
 
 puppet_version = ENV['PUPPET_GEM_VERSION']
@@ -49,7 +52,6 @@ end
 gems = {}
 
 gems['puppet'] = location_for(puppet_version)
-gems['puppet-strings'] = ['~> 1', { require: false }]
 
 # If facter or hiera versions have been specified via the environment
 # variables, use those versions. If not, and if the puppet version is < 3.5.0,
@@ -124,4 +126,5 @@ extra_gemfiles.each do |gemfile|
     eval(File.read(gemfile), binding)
   end
 end
+
 # vim: syntax=ruby

README.md

@@ -1,10 +1,16 @@
 # dovecot
 
-[![Build Status](https://travis-ci.org/wwkimball/wwkimball-dovecot.svg?branch=master)](https://travis-ci.org/wwkimball/wwkimball-dovecot) [![Documentation Coverage](https://inch-ci.org/github/wwkimball/wwkimball-dovecot.svg?branch=master)](https://inch-ci.org/github/wwkimball/wwkimball-dovecot) [![Version](https://img.shields.io/puppetforge/v/wwkimball/dovecot.svg)](https://forge.puppet.com/wwkimball/dovecot)
+[![Build Status](https://travis-ci.org/wwkimball/wwkimball-dovecot.svg?branch=master)](https://travis-ci.org/wwkimball/wwkimball-dovecot) [![Version](https://img.shields.io/puppetforge/v/wwkimball/dovecot.svg)](https://forge.puppet.com/wwkimball/dovecot) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3bfb5fb2b84042cf972b468eb1418b80)](https://www.codacy.com/app/wwkimball/wwkimball-dovecot?utm_source=github.com&utm_medium=referral&utm_content=wwkimball/wwkimball-dovecot&utm_campaign=Badge_Grade) [![Coverage Status](https://coveralls.io/repos/github/wwkimball/wwkimball-dovecot/badge.svg?branch=master)](https://coveralls.io/github/wwkimball/wwkimball-dovecot?branch=master)
 
 ### Foreword
 
-The author of this module has long promoted a line of thinking that builds off of **Infrastructure As Code** into **Infrastructure As Data**.  With Hiera and modules like this, you can express your entire enterprise infrastructure purely as data without any more code for you to write or manage (not even antiquated roles/profiles when you use Hiera as your external node classifier and Facter for role assignments).  As such, all examples in this document and the module's in-file documentation are presented strictly as YAML.
+The original author of this module has long promoted a line of thinking that
+builds off of **Infrastructure As Code** into **Infrastructure As Data**.  With
+Hiera and modules like this, end-users can simply import the code they need and
+then fully express their entire enterprise infrastructure purely as data without
+any more code to write or support (not even antiquated roles/profiles).  As
+such, all examples in this document and the module's in-file documentation are
+presented strictly as YAML.
 
 #### Table of Contents
 
@@ -20,7 +26,7 @@ The author of this module has long promoted a line of thinking that builds off o
 
 ## Description
 
-This module was written from scratch, specifically for Puppet 5 and Hiera 5 to fully manage dovecot; nothing more and nothing less.  No assumptions are made as to what you intend to do with dovecot other than install or uninstall it and its plugins, configure it or delete its configuration files, and -- when not ignoring it -- keep its service running or not running.
+This module was written from scratch, specifically for Puppet 5 and Hiera 5 to fully manage dovecot; nothing more and nothing less.  No assumptions are made as to what you intend to do with dovecot other than enjoy full control over it via Hiera in every respect.
 
 Here, "fully manage" means this Puppet module:
 
@@ -61,11 +67,11 @@ Many usage examples are provided via the source code documentation.  Refer to th
 
 ## Reference
 
-This module is extensively documented via [Puppet Strings](https://github.com/puppetlabs/puppet-strings).  Pre-generated, web-accessible reference documentation can be found at [GitHub Pages for this project](https://wwkimball.github.io/wwkimball-dovecot/docs/puppet_classes/dovecot.html).
+Pre-generated, web-accessible reference documentation -- with abundant **examples** -- can be found at [GitHub Pages for this project](https://wwkimball.github.io/wwkimball-dovecot/puppet_classes/dovecot.html), generated via [Puppet Strings](https://github.com/puppetlabs/puppet-strings).  If you do not have access to this on-line documentation, please just run `bundle install && bundle exec rake strings:generate` from this module's top directory to have a local copy of the documentation generated for you in the [docs](docs/index.html) directory.
 
 ## Limitations
 
-Please refer to the *operatingsystem_support* section of [metadata.json](metadata.json) for OS compatibility.  This is not an exhaustive list.  You will very likely find that this module runs just fine on other operating system and version combinations, given the proper inputs.
+Please refer to the *operatingsystem_support* section of [metadata.json](metadata.json) for known, proven-in-production OS compatibility.  This is not an exhaustive list.  You will very likely find that this module runs just fine on other operating system and version combinations, given the proper inputs.  In fact, if you do, please report it back so the metadata can be updated!
 
 ## Development
 

metadata.json

@@ -2,7 +2,7 @@
   "author": "William W. Kimball, Jr., MBA, MSIS",
   "name": "wwkimball-dovecot",
   "version": "0.1.0",
-  "summary": "Manages dovecot and its plugins",
+  "summary": "Fully manages dovecot and its plugins",
   "license": "Apache-2.0",
   "project_page": "https://github.com/wwkimball/wwkimball-dovecot",
   "source": "https://github.com/wwkimball/wwkimball-dovecot.git",
@@ -21,7 +21,7 @@
     }
   ],
   "requirements": [
-    { "name": "puppet", "version_requirement": ">= 5.0.0" }
+    { "name": "puppet", "version_requirement": ">= 4.9.0" }
   ],
   "tags": [ "dovecot", "hiera" ]
 }