Skip to content
Snippets Groups Projects
Commit 806813c2 authored by David Schmitt's avatar David Schmitt
Browse files

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`
parent 9c144338
No related branches found
No related tags found
No related merge requests found
...@@ -96,7 +96,7 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? ...@@ -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.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.add_pr_wo_labels = true
config.issues = false config.issues = false
config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM" config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB"
config.configure_sections = { config.configure_sections = {
"Changed" => { "Changed" => {
"prefix" => "### Changed", "prefix" => "### Changed",
...@@ -104,11 +104,11 @@ if Bundler.rubygems.find_name('github_changelog_generator').any? ...@@ -104,11 +104,11 @@ if Bundler.rubygems.find_name('github_changelog_generator').any?
}, },
"Added" => { "Added" => {
"prefix" => "### Added", "prefix" => "### Added",
"labels" => ["feature", "enhancement"], "labels" => ["enhancement", "feature"],
}, },
"Fixed" => { "Fixed" => {
"prefix" => "### Fixed", "prefix" => "### Fixed",
"labels" => ["bugfix"], "labels" => ["bug", "documentation", "bugfix"],
}, },
} }
end end
...@@ -116,16 +116,15 @@ else ...@@ -116,16 +116,15 @@ else
desc 'Generate a Changelog from GitHub' desc 'Generate a Changelog from GitHub'
task :changelog do task :changelog do
raise <<EOM 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`: Please manually add it to your .sync.yml for now, and run `pdk update`:
--- ---
Gemfile: Gemfile:
optional: optional:
':development': ':development':
- gem: 'github_changelog_generator' - gem: 'github_changelog_generator'
git: 'https://github.com/skywinder/github-changelog-generator' version: '~> 1.15'
ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')"
condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
EOM EOM
end end
end end
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment