Skip to content

Deduplicate leading verbs in auto-generated changelog entries #35

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

Draft
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Deduplicate leading verbs in auto-generated changelog entries #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8529050
Handle duplicated verbs in changelog titles
Copilot Jun 22, 2026
5e0d05c
Refine changelog title verb deduplication
Copilot Jun 22, 2026
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
35 changes: 34 additions & 1 deletion .github/scripts/update-changelog.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@ const TYPE_TO_PREFIX = {
refactor: "Refactored",
};

/**
* Maps changelog prefixes to verb forms that should be removed from title starts
* to avoid duplicated wording like "Added added ...".
*/
const PREFIX_TO_LEADING_VERB_REGEX = {
added: /^(add|adds|added|adding)\b[\s:-]*/i,
changed: /^(change|changes|changed|changing)\b[\s:-]*/i,
deprecated: /^(deprecate|deprecates|deprecated|deprecating)\b[\s:-]*/i,
fixed: /^(fix|fixes|fixed|fixing)\b[\s:-]*/i,
refactored: /^(refactor|refactors|refactored|refactoring)\b[\s:-]*/i,
removed: /^(remove|removes|removed|removing)\b[\s:-]*/i,
reverted: /^(revert|reverts|reverted|reverting)\b[\s:-]*/i,
};

/**
* Indentation used for PR description lines nested under a changelog list item 2 spaces.
*/
Expand Down Expand Up @@ -296,7 +310,26 @@ function buildEntry(
prBody,
) {
const prefix = TYPE_TO_PREFIX[type] ?? section;
return `- ${prefix} ${cleanedTitle} ([#${prNumber}](${prUrl})) by @${prAuthor}${formatPRDescription(prBody)}\n<!-- end -->`;
const dedupedTitle = removeLeadingDuplicateVerb(prefix, cleanedTitle);
const titlePart = dedupedTitle ? ` ${dedupedTitle}` : ` ${cleanedTitle.trim()}`;
return `- ${prefix}${titlePart} ([#${prNumber}](${prUrl})) by @${prAuthor}${formatPRDescription(prBody)}\n<!-- end -->`;
}

/**
* Removes duplicated leading verbs based on the resolved changelog prefix.
* Example: prefix "Added" + title "added support for x" => "support for x"
* @param {string} prefix - Resolved changelog entry prefix
* @param {string} title - Cleaned PR title
* @returns {string} - Title without duplicated leading verb
*/
function removeLeadingDuplicateVerb(prefix, title) {
const trimmedTitle = title.trim();
if (!trimmedTitle) return "";

const pattern = PREFIX_TO_LEADING_VERB_REGEX[prefix.toLowerCase()];
if (!pattern) return trimmedTitle;

return trimmedTitle.replace(pattern, "").trimStart();
}

/**
Expand Down