Conversation
…ctionality and improve pull request handling
…template generation
Contributor
There was a problem hiding this comment.
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
getDistinctWorkItemListFromPRsandWorkItemListfrommain.tsintoWorkItemUtils.ts - Updated import in
main.tsand removed the duplicated function - Changed the Markdown template to use
author.displayNameinstead ofauthor
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
WorkItemListlacks 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
getDistinctWorkItemListFromPRsdoes 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
WorkItemListsuggests a collection but represents a single aggregated work item; consider renaming toWorkItemAggregateorWorkItemSummaryfor clarity.
export interface WorkItemList {
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.