Merge pull request voxpupuli#310 from voxpupuli/modulesync

modulesync 5.4.0

.gitignore

@@ -1,23 +1,23 @@
 # Managed by modulesync - DO NOT EDIT
 # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
 
-pkg/
-Gemfile.lock
-Gemfile.local
-vendor/
-.vendor/
-spec/fixtures/manifests/
-spec/fixtures/modules/
-.vagrant/
-.bundle/
-.ruby-version
-coverage/
-log/
-.idea/
-.dependencies/
-.librarian/
-Puppetfile.lock
+/pkg/
+/Gemfile.lock
+/Gemfile.local
+/vendor/
+/.vendor/
+/spec/fixtures/manifests/
+/spec/fixtures/modules/
+/.vagrant/
+/.bundle/
+/.ruby-version
+/coverage/
+/log/
+/.idea/
+/.dependencies/
+/.librarian/
+/Puppetfile.lock
 *.iml
 .*.sw?
-.yardoc/
-Guardfile
+/.yardoc/
+/Guardfile

.puppet-lint.rc

@@ -1,2 +1 @@
 --fail-on-warnings
---no-parameter_documentation-check

.sync.yml

@@ -8,3 +8,4 @@ spec/spec_helper_acceptance.rb:
 .puppet-lint.rc:
   enabled_lint_checks:
     - parameter_types
+    - parameter_documentation

Gemfile

@@ -22,8 +22,7 @@ end
 
 group :release do
   gem 'github_changelog_generator', '>= 1.16.1',  :require => false if RUBY_VERSION >= '2.5'
-  gem 'voxpupuli-release', '>= 1.2.0',            :require => false
-  gem 'puppet-strings', '>= 2.2',                 :require => false
+  gem 'voxpupuli-release', '~> 2.0',              :require => false
 end
 
 gem 'rake', :require => false

REFERENCE.md

@@ -95,10 +95,10 @@ The following parameters are available in the `grafana` class:
 * [`toml_package_name`](#-grafana--toml_package_name)
 * [`toml_package_ensure`](#-grafana--toml_package_ensure)
 * [`toml_package_provider`](#-grafana--toml_package_provider)
-* [`cfg`](#-grafana--cfg)
 * [`docker_image`](#-grafana--docker_image)
 * [`docker_ports`](#-grafana--docker_ports)
 * [`rpm_iteration`](#-grafana--rpm_iteration)
+* [`cfg`](#-grafana--cfg)
 
 ##### <a name="-grafana--archive_source"></a>`archive_source`
 
@@ -191,8 +191,6 @@ Data type: `String`
 
 The name of the service managed with the 'archive' and 'package' install methods.
 
-Default value: `'grafana'`
-
 ##### <a name="-grafana--version"></a>`version`
 
 Data type: `String`
@@ -372,38 +370,38 @@ The package-provider used to install the TOML parser library.
 
 Default value: `undef`
 
-##### <a name="-grafana--cfg"></a>`cfg`
-
-Data type: `Variant[Hash,Sensitive[Hash]]`
-
-
-
-Default value: `{}`
-
 ##### <a name="-grafana--docker_image"></a>`docker_image`
 
 Data type: `String`
 
-
+name of the docker image that provides grafana
 
 Default value: `'grafana/grafana'`
 
 ##### <a name="-grafana--docker_ports"></a>`docker_ports`
 
 Data type: `String`
 
-
+ports docker should expose
 
 Default value: `'3000:3000'`
 
 ##### <a name="-grafana--rpm_iteration"></a>`rpm_iteration`
 
 Data type: `String`
 
-
+explicit Iteration / epoch for the rpm
 
 Default value: `'1'`
 
+##### <a name="-grafana--cfg"></a>`cfg`
+
+Data type: `Variant[Hash,Sensitive[Hash]]`
+
+The whole grafana configuration
+
+Default value: `{}`
+
 ### <a name="grafana--validator"></a>`grafana::validator`
 
 Manage grafana_conn_validator resource

Rakefile

@@ -24,6 +24,10 @@ end
 begin
   require 'voxpupuli/release/rake_tasks'
 rescue LoadError
+  # voxpupuli-release not present
+else
+  GCGConfig.user = 'voxpupuli'
+  GCGConfig.project = 'puppet-grafana'
 end
 
 desc "Run main 'test' task and report merged results to coveralls"
@@ -37,36 +41,4 @@ task test_with_coveralls: [:test] do
   end
 end
 
-desc 'Generate REFERENCE.md'
-task :reference, [:debug, :backtrace] do |t, args|
-  patterns = ''
-  Rake::Task['strings:generate:reference'].invoke(patterns, args[:debug], args[:backtrace])
-end
-
-begin
-  require 'github_changelog_generator/task'
-  require 'puppet_blacksmith'
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    metadata = Blacksmith::Modulefile.new
-    config.future_release = "v#{metadata.version}" if metadata.version =~ /^\d+\.\d+.\d+$/
-    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file.\nEach new release typically also includes the latest modulesync defaults.\nThese should not affect the functionality of the module."
-    config.exclude_labels = %w{duplicate question invalid wontfix wont-fix modulesync skip-changelog}
-    config.user = 'voxpupuli'
-    config.project = 'puppet-grafana'
-  end
-
-  # Workaround for https://github.com/github-changelog-generator/github-changelog-generator/issues/715
-  require 'rbconfig'
-  if RbConfig::CONFIG['host_os'] =~ /linux/
-    task :changelog do
-      puts 'Fixing line endings...'
-      changelog_file = File.join(__dir__, 'CHANGELOG.md')
-      changelog_txt = File.read(changelog_file)
-      new_contents = changelog_txt.gsub(%r{\r\n}, "\n")
-      File.open(changelog_file, "w") {|file| file.puts new_contents }
-    end
-  end
-
-rescue LoadError
-end
 # vim: syntax=ruby

manifests/init.pp

@@ -124,6 +124,18 @@
 # @param toml_package_provider
 #   The package-provider used to install the TOML parser library.
 #
+# @param docker_image
+#   name of the docker image that provides grafana
+#
+# @param docker_ports
+#   ports docker should expose
+#
+# @param rpm_iteration
+#   explicit Iteration / epoch for the rpm
+#
+# @param cfg
+#   The whole grafana configuration
+#
 # @example Using the Class
 #  class { '::grafana':
 #    install_method  => 'docker',