Skip to content

Improve changelog tool sorting and capitalization #6880

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

Merged
aduth merged 5 commits into from
Aug 31, 2022
Merged

Improve changelog tool sorting and capitalization #6880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3b69636
Use upcase_first to capitalize changelog subcategory
aduth Aug 31, 2022
dd064e4
Sort changelog by subcategory
aduth Aug 31, 2022
71e515f
Add ActiveSupport#inflector required gem support
aduth Aug 31, 2022
dd18500
Use shorthand syntax for sort_by block
aduth Aug 31, 2022
316b3c0
Remove upcase formatting from changelog script
aduth Aug 31, 2022
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
9 changes: 5 additions & 4 deletions scripts/changelog_check.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def generate_changelog(git_log)

changelog_entry = ChangelogEntry.new(
category: category,
subcategory: change[:subcategory].capitalize,
subcategory: change[:subcategory],
pr_number: pr_number&.named_captures&.fetch('pr'),
change: change[:change].sub(/./, &:upcase),
)
Expand All @@ -150,13 +150,14 @@ def generate_changelog(git_log)
# Entries with the same category and change are grouped into one changelog line so that we can
# support multi-PR changes.
def format_changelog(changelog_entries)
changelog_entries = changelog_entries.group_by { |entry| [entry.category, entry.change] }
changelog_entries = changelog_entries.
sort_by(&:subcategory).
group_by { |entry| [entry.category, entry.change] }

changelog = ''
CATEGORIES.each do |category|
category_changes = changelog_entries.
filter { |(changelog_category, _change), _changes| changelog_category == category }.
sort_by { |(_category, change), _changes| change }
filter { |(changelog_category, _change), _changes| changelog_category == category }

next if category_changes.empty?
changelog.concat("## #{category}\n")
Expand Down
26 changes: 12 additions & 14 deletions spec/scripts/changelog_check_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,23 +86,21 @@
- Security: Upgrade Rails to patch vulnerability ([#6041](https://github.com/18F/identity-idp/pull/6041), [#6042](https://github.com/18F/identity-idp/pull/6042))
CHANGELOG
end
end

describe '#generate_changelog' do
it 'capitalizes subcategory and capitalizes first letter of change description' do
git_log = <<~COMMIT
title: Add LOGIN_TASK_LOG_LEVEL env var (#6037)
body:- Lets us set log level to minimize STDOUT output
from Identity::Hostdata (downloading files from S3, etc)

* changelog: Improvements, authentication, provide better authentication (LG-4515)
DELIMITER
COMMIT

it 'sorts changelog by subcategory' do
commits = [
git_fixtures['squashed_commit_with_one_commit'],
git_fixtures['squashed_commit_2'],
]
git_log = commits.pluck('commit_log').join("\n")
changelogs = generate_changelog(git_log)
formatted_changelog = format_changelog(changelogs)

expect(changelogs.first.subcategory).to eq('Authentication')
expect(changelogs.first.change).to start_with('P')
expect(formatted_changelog).to eq <<~CHANGELOG.chomp
## Internal
- Logging: Update logging flow ([#9999](https://github.com/18F/identity-idp/pull/9999))
- Security: Upgrade Rails to patch vulnerability ([#6041](https://github.com/18F/identity-idp/pull/6041))
CHANGELOG
end
end

Expand Down