Skip to content

Add badge setting in README #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TheMeier wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add badge setting in README #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions lib/modulesync.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,30 @@ 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'))

$stdout.puts "Updating README badges for '#{puppet_module.given_name}'"
content = File.read(puppet_module.path('README.md'))
badge_start = '[//]: # (modulesync badges start)'
badge_end = '[//]: # (modulesync badges end)'
badge_regex = /#{Regexp.escape(badge_start)}.*?#{Regexp.escape(badge_end)}/m

build_status = "![Build Status](https://github.com/#{puppet_module.repository_namespace}/#{puppet_module.repository_name}/actions/workflows/ci.yml/badge.svg?branch=master)"
# rubocop:disable Layout/LineLength
code_coverage = "[![Code Coverage](https://coveralls.io/repos/github/#{puppet_module.repository_namespace}/#{puppet_module.repository_name}/badge.svg?branch=master)](https://coveralls.io/github/#{puppet_module.repository_namespace}/#{puppet_module.repository_name})"
# rubocop:enable Layout/LineLength
license = "[![License](https://img.shields.io/github/license/#{puppet_module.repository_namespace}/#{puppet_module.repository_name}.svg)](LICENSE)"

badges = [build_status, license]
badges << code_coverage if Dir.exist?(File.join(puppet_module.path, 'lib'))

new_content = "#{badge_start}\n#{badges.join("\n")}\n#{badge_end}"
return unless content.gsub!(badge_regex, new_content)

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
Expand All @@ -140,6 +164,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."
Expand Down