From 806813c2941e55c75507fe22cb940f24ded46dcc Mon Sep 17 00:00:00 2001
From: David Schmitt <david.schmitt@puppet.com>
Date: Wed, 10 Jun 2020 17:19:28 +0100
Subject: [PATCH] Update changelog generation: default github labels and new
upstream release
* Use a release version of github-changelog-generator. The gem has had several upstream releases recently fixing most of the issues we encountered. Most importantly the pdk default configuration for labels now works out of the box.
* Start aligning with github's default labels to reduce the effort for publishing a new module
** Add support for github's default labels "bug" and "documentation"
** List github's default labels first in the `configure_sections`
---
moduleroot/Rakefile.erb | 13 ++++++-------
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/moduleroot/Rakefile.erb b/moduleroot/Rakefile.erb
index e6ba783..9c0c94a 100644
--- a/moduleroot/Rakefile.erb
+++ b/moduleroot/Rakefile.erb
@@ -96,7 +96,7 @@ if Bundler.rubygems.find_name('github_changelog_generator').any?
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)."
config.add_pr_wo_labels = true
config.issues = false
- config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM"
+ config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB"
config.configure_sections = {
"Changed" => {
"prefix" => "### Changed",
@@ -104,11 +104,11 @@ if Bundler.rubygems.find_name('github_changelog_generator').any?
},
"Added" => {
"prefix" => "### Added",
- "labels" => ["feature", "enhancement"],
+ "labels" => ["enhancement", "feature"],
},
"Fixed" => {
"prefix" => "### Fixed",
- "labels" => ["bugfix"],
+ "labels" => ["bug", "documentation", "bugfix"],
},
}
end
@@ -116,16 +116,15 @@ else
desc 'Generate a Changelog from GitHub'
task :changelog do
raise <<EOM
-The changelog tasks depends on unreleased features of the github_changelog_generator gem.
+The changelog tasks depends on recent features of the github_changelog_generator gem.
Please manually add it to your .sync.yml for now, and run `pdk update`:
---
Gemfile:
optional:
':development':
- gem: 'github_changelog_generator'
- git: 'https://github.com/skywinder/github-changelog-generator'
- ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
- condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
+ version: '~> 1.15'
+ condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')"
EOM
end
end
--
GitLab