Rakefile

   1 # frozen_string_literal: true
   2
   3 require 'bundler'
   4 require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any?
   5 require 'puppetlabs_spec_helper/rake_tasks'
   6 require 'puppet-syntax/tasks/puppet-syntax'
   7 require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any?
   8 require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any?
   9 require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any?
  10
  11 def changelog_user
  12   return unless Rake.application.top_level_tasks.include? "changelog"
  13   returnVal = nil || JSON.load(File.read('metadata.json'))['author']
  14   raise "unable to find the changelog_user in .sync.yml, or the author in metadata.json" if returnVal.nil?
  15   puts "GitHubChangelogGenerator user:#{returnVal}"
  16   returnVal
  17 end
  18
  19 def changelog_project
  20   return unless Rake.application.top_level_tasks.include? "changelog"
  21
  22   returnVal = nil
  23   returnVal ||= begin
  24     metadata_source = JSON.load(File.read('metadata.json'))['source']
  25     metadata_source_match = metadata_source && metadata_source.match(%r{.*\/([^\/]*?)(?:\.git)?\Z})
  26
  27     metadata_source_match && metadata_source_match[1]
  28   end
  29
  30   raise "unable to find the changelog_project in .sync.yml or calculate it from the source in metadata.json" if returnVal.nil?
  31
  32   puts "GitHubChangelogGenerator project:#{returnVal}"
  33   returnVal
  34 end
  35
  36 def changelog_future_release
  37   return unless Rake.application.top_level_tasks.include? "changelog"
  38   returnVal = "v%s" % JSON.load(File.read('metadata.json'))['version']
  39   raise "unable to find the future_release (version) in metadata.json" if returnVal.nil?
  40   puts "GitHubChangelogGenerator future_release:#{returnVal}"
  41   returnVal
  42 end
  43
  44 PuppetLint.configuration.send('disable_relative')
  45
  46
  47 if Bundler.rubygems.find_name('github_changelog_generator').any?
  48   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
  49     raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil?
  50     config.user = "#{changelog_user}"
  51     config.project = "#{changelog_project}"
  52     config.future_release = "#{changelog_future_release}"
  53     config.exclude_labels = ['maintenance']
  54     config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)."
  55     config.add_pr_wo_labels = true
  56     config.issues = false
  57     config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB"
  58     config.configure_sections = {
  59       "Changed" => {
  60         "prefix" => "### Changed",
  61         "labels" => ["backwards-incompatible"],
  62       },
  63       "Added" => {
  64         "prefix" => "### Added",
  65         "labels" => ["enhancement", "feature"],
  66       },
  67       "Fixed" => {
  68         "prefix" => "### Fixed",
  69         "labels" => ["bug", "documentation", "bugfix"],
  70       },
  71     }
  72   end
  73 else
  74   desc 'Generate a Changelog from GitHub'
  75   task :changelog do
  76     raise <<EOM
  77 The changelog tasks depends on recent features of the github_changelog_generator gem.
  78 Please manually add it to your .sync.yml for now, and run `pdk update`:
  79 ---
  80 Gemfile:
  81   optional:
  82     ':development':
  83       - gem: 'github_changelog_generator'
  84         version: '~> 1.15'
  85         condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')"
  86 EOM
  87   end
  88 end
  89