feat: Add badge setting in README

Check README for a specific comment and if found replace badge URLs based on module settings.

Refs: voxpupuli/plumbing#84

Author: TheMeier

lib/modulesync.rb

@@ -116,6 +116,24 @@ def self.manage_file(puppet_module, filename, settings, options)
     end
   end
 
+  def self.update_readme_badges(puppet_module)
+    return unless File.exist?(puppet_module.path('README.md'))
+
+    content = File.read(puppet_module.path('README.md'))
+    badge_regex = %r{^\[//\]: # \(modulesync badge placeholder, do not remove\)$}
+
+    build_status = "![Build Status](https://github.com/voxpupuli/#{puppet_module.repository_name}/actions/workflows/ci.yml/badge.svg?branch=master)\n"
+    code_coverage = "[![Code Coverage](https://coveralls.io/repos/github/voxpupuli/#{puppet_module.repository_name}/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/#{puppet_module.repository_name})\n"
+    license = "[![License](https://img.shields.io/github/license/voxpupuli/#{puppet_module.repository_name}.svg)](LICENSE)\n"
+
+    badges = build_status
+    badges << license
+    badges << code_coverage if Dir.exist?(File.expand_path('./lib', puppet_module.path))
+    content.gsub!(badge_regex, badges.chomp)
+
+    File.write(puppet_module.path('README.md'), content)
+  end
+
   def self.manage_module(puppet_module, module_files, defaults)
     puts "Syncing '#{puppet_module.given_name}'"
     # NOTE: #prepare_workspace now supports to execute only offline operations
@@ -140,6 +158,7 @@ def self.manage_module(puppet_module, module_files, defaults)
 
     files_to_manage = settings.managed_files(module_files)
     files_to_manage.each { |filename| manage_file(puppet_module, filename, settings, options) }
+    update_readme_badges(puppet_module)
 
     if options[:noop]
       puts "Using no-op. Files in '#{puppet_module.given_name}' may be changed but will not be committed."