Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Replace `[Category]`, `[Subcategory]`, and `[Description]` with text relevant fo
- **Bug Fixes** are corrections to a broken behavior, such as preventing a raised exception.
- **Internal** are changes which benefit the Login.gov team, such as analytics or code quality.
- **Upcoming Features** are iterations contributing to a feature which has not yet been enabled for users in production.
- **Subcategory** does not have any restrictions, but you should try to maintain consistency with changesets affecting similar parts of the application (for example, "In-person proofing").
- **Subcategory** can be any value, but it cannot contain commas. Try to maintain consistency with changesets affecting similar parts of the application (for example, "In-person proofing").
- **Description** is a plain language description of the specific changes.

If multiple pull requests iterate on the same feature, it's a good idea to use the same commit message, since identical messages will be combined into a single entry when the release notes are compiled.
Expand Down
2 changes: 1 addition & 1 deletion scripts/changelog_check.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require 'optparse'

CHANGELOG_REGEX =
%r{^(?:\* )?changelog: ?(?<category>[\w -]{2,}), ?(?<subcategory>[\w -]{2,}), ?(?<change>.+)$}i
%r{^(?:\* )?changelog: ?(?<category>[\w -]{2,}), ?(?<subcategory>[^,]{2,}), ?(?<change>.+)$}i
CATEGORIES = [
'User-Facing Improvements',
'Bug Fixes',
Expand Down
12 changes: 12 additions & 0 deletions spec/fixtures/git_log_changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,18 @@ commit_changelog_capitalized:
pr_number: '7000'
commit_messages:
- 'ChAngElOg: Internal, Changelog, Improve changelog tool flexibility for commit messages'
commit_changelog_symbols:
commit_log: |
title: Support symbols in changelog message subcategory (#9697)
body:changelog: Internal, Build Tooling (Changelog Script), Support symbols in changelog message subcategory
DELIMITER
title: Support symbols in changelog message subcategory (#9697)
category: Internal
subcategory: Build Tooling (Changelog Script)
change: Support symbols in changelog message subcategory
pr_number: '9697'
commit_messages:
- 'changelog: Internal, Build Tooling (Changelog Script), Support symbols in changelog message subcategory'
commit_changelog_whitespace:
commit_log: |
title: Improve changelog tool flexibility for commit messages (#7000)
Expand Down
2 changes: 1 addition & 1 deletion spec/scripts/changelog_check_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
it 'builds a git log into structured changelog objects' do
git_log = git_fixtures.values.pluck('commit_log').join("\n")
changelog_entries = generate_changelog(git_log)
expect(changelog_entries.length).to eq 9
expect(changelog_entries.length).to eq 10
fixture_and_changelog = git_fixtures.values.filter do |x|
x['category'].present?
end.zip(changelog_entries)
Expand Down