Group dependencies by version range in backflow PR descriptions #4991

Copilot · 2025-06-20T09:06:46Z

This PR implements dependency grouping in backflow PR descriptions to reduce visual noise when multiple packages have the same version update.

Problem

Currently, each dependency update is listed individually with its own link, creating repetitive output:

**Updated Dependencies**
- **Microsoft.TemplateEngine.Abstractions**: [from 10.0.100-preview.6.25317.107 to 10.0.100-preview.6.25318.104][1]
- **Microsoft.TemplateEngine.Edge**: [from 10.0.100-preview.6.25317.107 to 10.0.100-preview.6.25318.104][1]  
- **Microsoft.TemplateEngine.Utils**: [from 10.0.100-preview.6.25317.107 to 10.0.100-preview.6.25318.104][1]

Solution

Dependencies with the same version range and commit range are now grouped under a single link:

**Updated Dependencies**
- From [10.0.100-preview.6.25317.107 to 10.0.100-preview.6.25318.104][1]
  - Microsoft.TemplateEngine.Abstractions
  - Microsoft.TemplateEngine.Edge
  - Microsoft.TemplateEngine.Utils

Changes

Codeflow PRs: Modified CreateDependencyUpdateBlock method to group dependencies by version and commit ranges
Dependency Flow PRs: Modified AppendBuildDescription method to group dependencies while preserving reference-style links
Tests: Added comprehensive tests for both code paths and updated existing test expectations

Implementation Details

Both code paths now:

Group dependencies by (FromVersion, ToVersion, FromCommit, ToCommit) tuple
Display one link per group with the version range
List individual package names under each group
Maintain existing reference-style link functionality where applicable

Fixes #4983.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

adamzip

There are two cases where you should remove a new line in the test strings in order to make the test pass

test/ProductConstructionService.DependencyFlow.Tests/PullRequestBuilderTests.cs

Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

Co-authored-by: premun <7013027+premun@users.noreply.github.com>

adamzip · 2025-06-20T14:48:36Z

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

@@ -407,10 +407,28 @@ internal static string CreateDependencyUpdateBlock(
        {
            stringBuilder.AppendLine();
            stringBuilder.AppendLine("**Updated Dependencies**");
-            foreach (DependencyUpdateSummary depUpdate in dependencyCategories.UpdatedDependencies)
+
+            // Group dependencies by version range and commit range


This implementation is great, but there's an issue. You implemented the grouping only for updated dependencies. Sorry if I wasn't clear about it, but all changes in dependencies should have this "grouped" formatting - including RemovedDependencies and AddedDependencies - not just UpdatedDependencies.
Please also add a test to reflect this - where there's a bunch of dependency changes of all 3 types: additions, removals, and version updates

Extended the grouping functionality to all dependency types (New, Removed, Updated) as requested. Dependencies are now grouped by version and commit for all three categories, with alphabetical sorting within each group. Added a comprehensive test case that covers multiple dependencies of each type to verify the functionality works correctly. (d7eef5e)

Look, that's great and it works, but I don't like that we are almost duplicating the same grouping functionality 3 times. I think we should be able to do the grouping logic just one time on the entire list of dependency changes. Maybe that would require modifying or even getting rid of the method CreateDependencyCategories, I don't know. But I think that grouping by FromCommitSha, FromVersion, ToCommitSha, and ToVersion just like you did, should cover the cases of grouping for all 3 types of dependency changes (additions, removals, and updates)

Refactored to use a unified grouping approach that eliminates code duplication. All dependencies are now grouped by FromCommitSha, FromVersion, ToCommitSha, and ToVersion in a single operation, then separated by type based on which values are null/empty. This removes the three separate grouping blocks and the CreateDependencyCategories method. (615219d)

Very good. Let's go one step further: I think GetLinkForDependencyItem can be refactored a bit so it just takes the repoUri, an "old" commit sha and a "new" commit sha. No need to take a DependencyUpdateSummary.

Refactored GetLinkForDependencyItem to take repoUri, fromCommitSha, and toCommitSha as separate parameters instead of DependencyUpdateSummary. Updated all call sites accordingly. (88a18c6)

…comprehensive tests Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

… duplication Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

adamzip · 2025-06-20T15:14:13Z

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

        {
            stringBuilder.AppendLine();
            stringBuilder.AppendLine("**New Dependencies**");
-            foreach (DependencyUpdateSummary depUpdate in dependencyCategories.NewDependencies)
+


Suggested change

Removed extra blank line. (88a18c6)

adamzip · 2025-06-20T15:14:16Z

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

        {
            stringBuilder.AppendLine();
            stringBuilder.AppendLine("**Removed Dependencies**");
-            foreach (DependencyUpdateSummary depUpdate in dependencyCategories.RemovedDependencies)
+


Suggested change

Removed extra blank line. (88a18c6)

adamzip · 2025-06-20T15:14:23Z

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

-        IReadOnlyCollection<DependencyUpdateSummary> RemovedDependencies,
-        IReadOnlyCollection<DependencyUpdateSummary> UpdatedDependencies
-    );
+


Suggested change

Removed extra blank lines. (88a18c6)

adamzip · 2025-06-20T15:17:27Z

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

+            .ToList();
+
+        // Separate groups by dependency type
+        var newDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.FromVersion)).ToList();


Let's make it more explicit:

Suggested change

var newDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.FromVersion)).ToList();

var newDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.FromVersion) && !string.IsNullOrEmpty(g.Key.ToVersion)).ToList();

Made the dependency filtering explicit by checking both conditions: string.IsNullOrEmpty(g.Key.FromVersion) && !string.IsNullOrEmpty(g.Key.ToVersion) for new dependencies. (88a18c6)

adamzip · 2025-06-20T15:17:57Z

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

+
+        // Separate groups by dependency type
+        var newDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.FromVersion)).ToList();
+        var removedDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.ToVersion)).ToList();


Let's make it more explicit:

Suggested change

var removedDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.ToVersion)).ToList();

var removedDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.ToVersion) && !string.IsNullOrEmpty(g.Key.FromVersion)).ToList();

Made the dependency filtering explicit by checking both conditions: string.IsNullOrEmpty(g.Key.ToVersion) && !string.IsNullOrEmpty(g.Key.FromVersion) for removed dependencies. (88a18c6)

adamzip · 2025-06-20T16:40:29Z

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs

@@ -407,10 +407,28 @@ internal static string CreateDependencyUpdateBlock(
        {
            stringBuilder.AppendLine();
            stringBuilder.AppendLine("**Updated Dependencies**");
-            foreach (DependencyUpdateSummary depUpdate in dependencyCategories.UpdatedDependencies)
+
+            // Group dependencies by version range and commit range


Very good. Let's go one step further: I think GetLinkForDependencyItem can be refactored a bit so it just takes the repoUri, an "old" commit sha and a "new" commit sha. No need to take a DependencyUpdateSummary.

…r review feedback Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

Initial plan for issue

8769d93

Copilot AI assigned Copilot and adamzip Jun 20, 2025

Copilot started work on behalf of adamzip June 20, 2025 09:06 View session

Copilot AI and others added 2 commits June 20, 2025 09:17

Implement dependency grouping for codeflow PRs

19d01e6

Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

Implement dependency grouping for both codeflow and dependency flow PRs

e810451

Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Declutter the "updated dependencies" section in backflow PRs~~ Group dependencies by version range in backflow PR descriptions Jun 20, 2025

Copilot AI requested a review from adamzip June 20, 2025 09:30

Copilot finished work on behalf of adamzip June 20, 2025 09:30

adamzip requested changes Jun 20, 2025

View reviewed changes

test/ProductConstructionService.DependencyFlow.Tests/PullRequestBuilderTests.cs Show resolved Hide resolved

test/ProductConstructionService.DependencyFlow.Tests/PullRequestBuilderTests.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of adamzip June 20, 2025 13:29 View session

Fix test string formatting by removing extra newlines

76e1501

Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

Copilot AI requested a review from adamzip June 20, 2025 13:42

Copilot finished work on behalf of adamzip June 20, 2025 13:42

adamzip approved these changes Jun 20, 2025

View reviewed changes

premun reviewed Jun 20, 2025

View reviewed changes

src/ProductConstructionService/ProductConstructionService.DependencyFlow/PullRequestBuilder.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of premun June 20, 2025 14:20 View session

Sort dependencies alphabetically by DependencyName within groups

3dead3e

Co-authored-by: premun <7013027+premun@users.noreply.github.com>

Copilot AI requested a review from premun June 20, 2025 14:26

Copilot finished work on behalf of premun June 20, 2025 14:26

premun marked this pull request as ready for review June 20, 2025 14:27

adamzip reviewed Jun 20, 2025

View reviewed changes

Copilot started work on behalf of adamzip June 20, 2025 14:48 View session

Extend dependency grouping to all types (New, Removed, Updated) with …

d7eef5e

…comprehensive tests Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

Copilot AI requested a review from adamzip June 20, 2025 14:56

Copilot finished work on behalf of adamzip June 20, 2025 14:56

Copilot started work on behalf of adamzip June 20, 2025 15:03 View session

Refactor dependency grouping to use unified approach eliminating code…

615219d

… duplication Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

Copilot finished work on behalf of adamzip June 20, 2025 15:11

adamzip reviewed Jun 20, 2025

View reviewed changes

Copilot started work on behalf of adamzip June 20, 2025 16:40 View session

Refactor GetLinkForDependencyItem and improve dependency filtering pe…

0fada44

…r review feedback Co-authored-by: adamzip <3237436+adamzip@users.noreply.github.com>

Copilot AI requested a review from adamzip June 20, 2025 16:47

Copilot finished work on behalf of adamzip June 20, 2025 16:47

adamzip approved these changes Jun 23, 2025

View reviewed changes

premun approved these changes Jun 25, 2025

View reviewed changes

dkurepa approved these changes Jun 25, 2025

View reviewed changes

adamzip merged commit 7b6990a into main Jun 25, 2025
9 checks passed

adamzip deleted the copilot/fix-4983 branch June 25, 2025 08:51

	var newDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.FromVersion)).ToList();
	var newDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.FromVersion) && !string.IsNullOrEmpty(g.Key.ToVersion)).ToList();

	var removedDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.ToVersion)).ToList();
	var removedDependencyGroups = dependencyGroups.Where(g => string.IsNullOrEmpty(g.Key.ToVersion) && !string.IsNullOrEmpty(g.Key.FromVersion)).ToList();

Group dependencies by version range in backflow PR descriptions #4991

Group dependencies by version range in backflow PR descriptions #4991

Uh oh!

Conversation

Copilot AI commented Jun 20, 2025 • edited by premun Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Changes

Implementation Details

Uh oh!

adamzip left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jun 20, 2025 •

edited by premun

Loading