Skip to content

Fix: Markdown PR author#12

Merged
IeuanWalker merged 2 commits intomasterfrom
Fix/MarkdownPrAuther
Jul 3, 2025
Merged

Fix: Markdown PR author#12
IeuanWalker merged 2 commits intomasterfrom
Fix/MarkdownPrAuther

Conversation

@IeuanWalker
Copy link
Owner

No description provided.

@IeuanWalker IeuanWalker requested a review from Copilot July 3, 2025 14:48
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR centralizes the getDistinctWorkItemListFromPRs logic into a utility module, introduces a WorkItemList interface for aggregated work items, and fixes the Markdown template to display the PR author’s name.

  • Extracted and exported getDistinctWorkItemListFromPRs and WorkItemList from main.ts into WorkItemUtils.ts
  • Updated import in main.ts and removed the duplicated function
  • Changed the Markdown template to use author.displayName instead of author

Reviewed Changes

Copilot reviewed 3 out of 8 changed files in this pull request and generated no comments.

File Description
CommitRangeReleaseNotesTask/task/utils/WorkItemUtils.ts Added WorkItemList interface and getDistinctWorkItemListFromPRs function
CommitRangeReleaseNotesTask/task/main.ts Updated imports and removed inlined duplicate of getDistinctWorkItemListFromPRs
CommitRangeReleaseNotesTask/task/defaultTemplateMarkdown.hbs Updated author column to use author.displayName
Comments suppressed due to low confidence (3)

CommitRangeReleaseNotesTask/task/utils/WorkItemUtils.ts:19

  • Public interface WorkItemList lacks documentation. Consider adding a JSDoc comment explaining its purpose and fields.
export interface WorkItemList {

CommitRangeReleaseNotesTask/task/utils/WorkItemUtils.ts:104

  • The newly added utility function getDistinctWorkItemListFromPRs does not seem to have associated unit tests; consider adding tests to cover its logic and edge cases.
export function getDistinctWorkItemListFromPRs(prs: PullRequest[]): WorkItemList[] {

CommitRangeReleaseNotesTask/task/utils/WorkItemUtils.ts:19

  • [nitpick] The name WorkItemList suggests a collection but represents a single aggregated work item; consider renaming to WorkItemAggregate or WorkItemSummary for clarity.
export interface WorkItemList {

@IeuanWalker IeuanWalker merged commit 4a5579f into master Jul 3, 2025
1 check passed
@IeuanWalker IeuanWalker deleted the Fix/MarkdownPrAuther branch July 3, 2025 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments