Add excludeVersionOnlyChanges option to prevent version bumps and changelog updates from requiring change files by Copilot · Pull Request #5595 · microsoft/rushstack

Copilot · 2026-02-04T01:17:24Z

Implementation Complete ✅

Summary

Successfully implemented the excludeVersionOnlyChanges option for ProjectChangeAnalyzer.getChangedProjectsAsync with optimized performance and high code quality:

Excludes version-only changes and changelog updates: When enabled, the analyzer ignores:
- Projects with only version-only changes to /package.json at project root (only the "version" field differs)
- Changes to /CHANGELOG.md and /CHANGELOG.json files at project root
- Combinations of the above (e.g., version bump + changelog update)
Uses Git blob ids efficiently: The implementation uses both oldhash and newhash from IFileDiffStatus to retrieve committed versions directly from Git, avoiding working tree inconsistencies.
Optimized performance: Version-only checks are integrated into the main loop with a deduplicated helper function using early returns, allowing concurrent processing and avoiding race conditions. Results are sorted using stable ordinal comparison.
Accurate path matching: Uses lookup.findLongestPrefixMatch to ensure only project-root files are excluded, not files with similar names in subdirectories.
Integrates with ChangeAction: The option is automatically enabled in ChangeAction to prevent rush version --bump from triggering rush change --verify failures.
Includes comprehensive tests: Added 8 test cases with clean jest.fn() mocks that verify:
- Version-only changes are excluded when option is enabled
- Non-version changes are still detected
- Multiple file changes (including package.json) are detected
- CHANGELOG files are ignored when appropriate
- Projects with CHANGELOG changes AND other changes are still detected
- Existing functionality continues to work
Exported helper function: The isPackageJsonVersionOnlyChange function is exported with 6 dedicated unit tests covering various scenarios including missing version fields, invalid JSON, and whitespace differences.
Change file added: Created Rush change file documenting the behavior change that prevents false positives after version bumps and changelog updates.

All tests pass successfully (572 tests total, up from 563).

Original prompt

On ProjectChangeAnalyzer.ts, Add a new option to ProjectChangeAnalyzer.getChangedProjectsAsync called excludeVersionOnlyChanges that, when configured, for each project, if the only change to the project is to its package.json, diffs the file against the base version to see if the only change is to the value of the "version" field, and if it is, ignores the change to the project.

Use this option when invoking this method in ChangeAction so that the result of rush version --bump does not itself trigger a request from rush change --verify for a change file.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

dmichon-msft · 2026-02-04T01:30:57Z

libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts

-          }
-        ]
-      ]);
+      return mockRepoChanges;


@copilot Use a module-level jest.fn() as the implementation so that each test case can set its expectations cleanly.

Done in db48dd8. Refactored to use mockGetRepoChanges = jest.fn() at module level, allowing each test to set expectations cleanly with mockGetRepoChanges.mockReturnValue().

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

dmichon-msft · 2026-02-04T01:31:37Z

libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts

 const { Git: OriginalGit } = jest.requireActual('../Git');
+
+// Store mock package.json contents for testing excludeVersionOnlyChanges
+const mockPackageJsonContents: Map<string, string> = new Map();


@copilot leverage jest.fn() to replace the implementation of getBlobContentAsync and have each test specify its desired behavior.

Done in db48dd8. Replaced the Map-based implementation with mockGetBlobContentAsync = jest.fn(), allowing each test to specify behavior using mockGetBlobContentAsync.mockResolvedValue().

dmichon-msft · 2026-02-04T01:37:05Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

    }

+    // Check for version-only changes if excludeVersionOnlyChanges is enabled
+    if (excludeVersionOnlyChanges) {


@copilot Move this processing into the existing calculation of changedProjects from changesByProject; if projectChanges.size === 1 (or filteredChanges.size === 1), apply the check before adding the project to changedProjects.

This means that the else branch will switch to using Async.forEachAsync to assemble changedProjects and allow the package.json reads to occur concurrently.

To avoid race conditions in the results, sort the set by projectRelativePath before returning it.

Done in ab2c187. Moved the check into the main loop (both branches) and applied it before adding projects to changedProjects. Changed the else branch to use Async.forEachAsync for concurrent processing. Results are now sorted by projectRelativeFolder before returning.

dmichon-msft · 2026-02-04T01:38:32Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+      const oldPackageJsonWithoutVersion: Record<string, unknown> = { ...oldPackageJson };
+      const currentPackageJsonWithoutVersion: Record<string, unknown> = { ...currentPackageJson };
+      delete oldPackageJsonWithoutVersion.version;
+      delete currentPackageJsonWithoutVersion.version;


@copilot

Suggested change

const oldPackageJsonWithoutVersion: Record<string, unknown> = { ...oldPackageJson };

const currentPackageJsonWithoutVersion: Record<string, unknown> = { ...currentPackageJson };

delete oldPackageJsonWithoutVersion.version;

delete currentPackageJsonWithoutVersion.version;

oldPackageJson.version = undefined;

currentPackageJson.version = undefined;

The objects are freshly created by JSON.parse so no need to clone them.

Done in ab2c187. Removed cloning and now directly delete properties on the fresh objects from JSON.parse.

dmichon-msft · 2026-02-04T01:40:25Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+      // Check if the only difference is the version field
+      const oldVersionlessJson: string = JSON.stringify(oldPackageJsonWithoutVersion, null, 2);
+      const currentVersionlessJson: string = JSON.stringify(currentPackageJsonWithoutVersion, null, 2);
+
+      return (
+        oldVersionlessJson === currentVersionlessJson && oldPackageJson.version !== currentPackageJson.version
+      );


@copilot

Suggested change

// Check if the only difference is the version field

const oldVersionlessJson: string = JSON.stringify(oldPackageJsonWithoutVersion, null, 2);

const currentVersionlessJson: string = JSON.stringify(currentPackageJsonWithoutVersion, null, 2);

return (

oldVersionlessJson === currentVersionlessJson && oldPackageJson.version !== currentPackageJson.version

);

return JSON.stringify(oldPackageJson) === JSON.stringify(currentPackageJson);

If they are exactly identical, then any difference is in the version field or in whitespace, both of which can be comfortably ignored. Pretty printing the JSON just wastes CPU cycles.

Done in ab2c187. Simplified to JSON.stringify(oldPackageJson) === JSON.stringify(currentPackageJson) without pretty printing, as exact equality means any difference is in version or whitespace (both ignorable).

dmichon-msft · 2026-02-04T01:43:42Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+
+      // Get the current version of package.json
+      const currentPackageJsonPath: string = path.join(repoRoot, packageJsonPath);
+      const currentPackageJsonContent: string = await FileSystem.readFileAsync(currentPackageJsonPath);


@copilot
Use this._git.getBlobContentAsync for the current version as well, since technically rush change compares the staged or committed version against the old version, not the working tree copy.

Done in ab2c187. Now using this._git.getBlobContentAsync with diffStatus.newhash for the current version, which gets the staged/committed version instead of the working tree copy. Tests updated to mock accordingly.

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

- Move check into main loop to avoid race conditions - Use getBlobContentAsync for both old and new versions - Simplify JSON comparison without pretty printing - Check for 'M' status to exclude additions/deletions - Sort results by projectRelativeFolder for consistency - Update tests to mock getBlobContentAsync correctly Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

dmichon-msft

Address feedback

dmichon-msft · 2026-02-04T19:25:05Z

libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts

 ]);
+
+// Mock function for customizing repo changes in each test
+const mockGetRepoChanges = jest.fn<Map<string, IFileDiffStatus>, []>();


@copilot

Suggested change

const mockGetRepoChanges = jest.fn<Map<string, IFileDiffStatus>, []>();

const mockGetRepoChanges: jest.MockedFunction<typeof import('@rushstack/package-deps-hash').getRepoChanges> = jest.fn();

Done in 57fbb6b. Added proper type annotation jest.MockedFunction<typeof import('@rushstack/package-deps-hash').getRepoChanges>.

dmichon-msft · 2026-02-04T19:26:21Z

libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts

 const { Git: OriginalGit } = jest.requireActual('../Git');
+
+// Mock function for getBlobContentAsync to be customized in each test
+const mockGetBlobContentAsync = jest.fn<Promise<string>, [{ blobSpec: string; repositoryRoot: string }]>();


@copilot

Suggested change

const mockGetBlobContentAsync = jest.fn<Promise<string>, [{ blobSpec: string; repositoryRoot: string }]>();

const mockGetBlobContentAsync: jest.MockedFunction<typeof import('../Git').Git.prototype.getBlobContentAsync> = jest.fn();

Done in 57fbb6b. Added proper type annotation jest.MockedFunction<typeof import('../Git').Git.prototype.getBlobContentAsync>.

libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts

dmichon-msft · 2026-02-04T19:31:06Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

          if (filteredChanges.size > 0) {
+            // Check for version-only changes if excludeVersionOnlyChanges is enabled
+            if (excludeVersionOnlyChanges && filteredChanges.size === 1) {
+              const packageJsonPath: string = Path.convertToSlashes(
+                path.relative(repoRoot, path.join(project.projectFolder, 'package.json'))
+              );
+              const diffStatus: IFileDiffStatus | undefined = filteredChanges.get(packageJsonPath);
+              if (diffStatus) {
+                const isVersionOnlyChange: boolean = await this._isVersionOnlyChangeAsync(
+                  diffStatus,
+                  repoRoot
+                );
+                if (isVersionOnlyChange) {
+                  return; // Skip adding this project
+                }
+              }
+            }
            changedProjects.add(project);
          }


@copilot Deduplicate this function: it looks like it takes project and projectChanges as arguments (changedProjects can be captured by the closure), and the behavior is otherwise identical.

Done in 57fbb6b. Created checkAndAddProject helper function that takes project and projectChanges as parameters, with changedProjects captured by closure. Both filtering and non-filtering branches now use this deduplicated function.

dmichon-msft · 2026-02-04T19:32:21Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

-    return changedProjects;
+    // Sort the set by projectRelativeFolder to avoid race conditions in the results
+    const sortedChangedProjects: RushConfigurationProject[] = Array.from(changedProjects).sort((a, b) =>
+      a.projectRelativeFolder.localeCompare(b.projectRelativeFolder)


@copilot Don't ever use localeCompare when performing a sort that needs to be stable: behavior varies depending on the user's locale. Always use < and > to ensure ordinal string comparison. There's a Sort.sortBy method in @rushstack/node-core-library that may simplify this.

Done in 57fbb6b. Replaced localeCompare with Sort.sortBy(sortedChangedProjects, (project) => project.projectRelativeFolder) for stable ordinal string comparison.

dmichon-msft · 2026-02-04T19:34:00Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+      // Parse both versions
+      const oldPackageJson: Record<string, unknown> = JSON.parse(oldPackageJsonContent);
+      const currentPackageJson: Record<string, unknown> = JSON.parse(currentPackageJsonContent);
+
+      // Ensure both have a version field
+      if (!oldPackageJson.version || !currentPackageJson.version) {
+        return false;
+      }
+
+      // Remove the version field from both (no need to clone, these are fresh objects from JSON.parse)
+      oldPackageJson.version = undefined;
+      currentPackageJson.version = undefined;
+
+      // Compare the objects without the version field
+      return JSON.stringify(oldPackageJson) === JSON.stringify(currentPackageJson);


@copilot Factor this part of the logic out into its own helper function (exported from the module) and give it its own unit tests.

Done in 57fbb6b. Extracted isPackageJsonVersionOnlyChange as a public exported function with its own unit tests. Added 6 test cases covering version-only changes, other field changes, missing version fields, invalid JSON, and whitespace differences.

…tests - Add proper jest.MockedFunction types for mock functions - Add test for package.json + other file changes scenario - Deduplicate version-only check logic into helper function - Use Sort.sortBy for stable ordinal string comparison - Extract isPackageJsonVersionOnlyChange as exported helper - Add comprehensive unit tests for the helper function Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

dmichon-msft · 2026-02-04T23:10:01Z

@copilot need to create a Rush change file for @microsoft/rush detailing the behavior change.

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

Copilot · 2026-02-04T23:12:23Z

@copilot need to create a Rush change file for @microsoft/rush detailing the behavior change.

Done in 0138de3. Created Rush change file documenting the behavior change that prevents rush change --verify from reporting false positives after rush version --bump updates package versions.

dmichon-msft · 2026-02-04T23:32:18Z

@copilot , adjust the behavior of this new flag to also automatically ignore any changes to CHANGELOG.md and CHANGELOG.json (match whatever casing is used in Rush's code that generates said files).

- Filter out CHANGELOG.md and CHANGELOG.json changes - Update logic to check all changed files, not just single file - Add tests for CHANGELOG file exclusion scenarios - Update documentation to reflect expanded behavior Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

Copilot · 2026-02-04T23:41:41Z

@copilot , adjust the behavior of this new flag to also automatically ignore any changes to CHANGELOG.md and CHANGELOG.json (match whatever casing is used in Rush's code that generates said files).

Done in 3691d49. Extended the flag to automatically ignore changes to CHANGELOG.md and CHANGELOG.json files (matching the exact casing used in Rush's changelog generation code). Added two test cases: one verifying that projects with only version-only package.json + CHANGELOG changes are excluded, and another verifying that projects with CHANGELOG + other substantive changes are still detected.

dmichon-msft · 2026-02-04T23:46:17Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+          // Only add project if there are non-excluded changes
+          if (filteredProjectChanges.size > 0) {
+            changedProjects.add(project);
+          }


@copilot
This can be simplified by adding it to the set during the loop and immediately returning.

Also restructure the code to immediately return if projectChanges.size === 0 to reduce nesting depth.

Done in b514856. Added immediate return when projectChanges.size === 0 to reduce nesting, and simplified the logic to add the project to the set during the loop with an immediate return when a non-excluded change is found.

dmichon-msft · 2026-02-04T23:49:12Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+          const filteredProjectChanges: Map<string, IFileDiffStatus> = new Map();
+
+          for (const [filePath, diffStatus] of projectChanges) {
+            const fileName: string = path.basename(filePath);


@copilot
Use lookup.findLongestPrefixMatch(filePath) to find the remainder of the path after accounting for the project root (i.e. slice filePath starting at match.index). Then filter out exactly /CHANGELOG.md, /CHANGELOG.json and process /package.json.
We don't want to exclude these files if they aren't the files Rush manipulates.

Done in b514856. Now using lookup.findLongestPrefixMatch(filePath) to find the project-relative path via match.index, then filtering exactly /CHANGELOG.md, /CHANGELOG.json, and /package.json. This ensures we only exclude the specific files Rush manipulates at the project root.

dmichon-msft · 2026-02-04T23:49:53Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+            changedProjects.add(project);
+          }
+        } else {
+          changedProjects.add(project);


@copilot
Similarly, invert the if and use an early return to reduce nesting.

Done in b514856. Inverted the if (!excludeVersionOnlyChanges) condition with an early return to reduce nesting depth.

- Add early returns to reduce nesting depth - Use lookup.findLongestPrefixMatch for accurate path matching - Only exclude /CHANGELOG.md, /CHANGELOG.json, /package.json at project root - Add type annotation for IPrefixMatch - Simplify control flow with immediate returns Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

Initial plan

4f4b2a6

Copilot AI assigned Copilot and dmichon-msft Feb 4, 2026

github-project-automation bot added this to Bug Triage Feb 4, 2026

github-project-automation bot moved this to Needs triage in Bug Triage Feb 4, 2026

Copilot started work on behalf of dmichon-msft February 4, 2026 01:17 View session

Copilot AI and others added 2 commits February 4, 2026 01:25

Add excludeVersionOnlyChanges option to ProjectChangeAnalyzer

3236665

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

Add tests for excludeVersionOnlyChanges functionality

1d0d94e

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

dmichon-msft reviewed Feb 4, 2026

View reviewed changes

Address code review feedback

585ee42

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

dmichon-msft reviewed Feb 4, 2026

View reviewed changes

Copilot AI changed the title ~~[WIP] Add excludeVersionOnlyChanges option to getChangedProjectsAsync~~ Add excludeVersionOnlyChanges option to prevent version bumps from requiring change files Feb 4, 2026

Copilot AI requested a review from dmichon-msft February 4, 2026 01:35

Copilot finished work on behalf of dmichon-msft February 4, 2026 01:35

Copilot started work on behalf of dmichon-msft February 4, 2026 01:35 View session

dmichon-msft reviewed Feb 4, 2026

View reviewed changes

Refactor test mocks to use jest.fn() for cleaner test setup

db48dd8

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

dmichon-msft reviewed Feb 4, 2026

View reviewed changes

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts Show resolved Hide resolved

Copilot AI requested a review from dmichon-msft February 4, 2026 01:45

Copilot finished work on behalf of dmichon-msft February 4, 2026 01:45

Copilot started work on behalf of dmichon-msft February 4, 2026 01:45 View session

Copilot finished work on behalf of dmichon-msft February 4, 2026 01:55

dmichon-msft reviewed Feb 4, 2026

View reviewed changes

Copilot started work on behalf of dmichon-msft February 4, 2026 19:34 View session

Copilot AI requested a review from dmichon-msft February 4, 2026 19:45

Copilot finished work on behalf of dmichon-msft February 4, 2026 19:45

dmichon-msft approved these changes Feb 4, 2026

View reviewed changes

dmichon-msft marked this pull request as ready for review February 4, 2026 23:08

dmichon-msft requested review from apostolisms, iclanton and octogonz as code owners February 4, 2026 23:08

Copilot started work on behalf of dmichon-msft February 4, 2026 23:10 View session

Add Rush change file for excludeVersionOnlyChanges behavior

0138de3

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>

Copilot AI requested a review from dmichon-msft February 4, 2026 23:12

Copilot finished work on behalf of dmichon-msft February 4, 2026 23:12

Copilot started work on behalf of dmichon-msft February 4, 2026 23:32 View session

Copilot AI changed the title ~~Add excludeVersionOnlyChanges option to prevent version bumps from requiring change files~~ Add excludeVersionOnlyChanges option to prevent version bumps and changelog updates from requiring change files Feb 4, 2026

Copilot finished work on behalf of dmichon-msft February 4, 2026 23:42

dmichon-msft reviewed Feb 4, 2026

View reviewed changes

Copilot started work on behalf of dmichon-msft February 4, 2026 23:50 View session

Copilot AI requested a review from dmichon-msft February 4, 2026 23:59

Copilot finished work on behalf of dmichon-msft February 4, 2026 23:59

	const mockGetRepoChanges = jest.fn<Map<string, IFileDiffStatus>, []>();
	const mockGetRepoChanges: jest.MockedFunction<typeof import('@rushstack/package-deps-hash').getRepoChanges> = jest.fn();

	const mockGetBlobContentAsync = jest.fn<Promise<string>, [{ blobSpec: string; repositoryRoot: string }]>();
	const mockGetBlobContentAsync: jest.MockedFunction<typeof import('../Git').Git.prototype.getBlobContentAsync> = jest.fn();

Conversation

Copilot AI commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Implementation Complete ✅

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

dmichon-msft Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dmichon-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

dmichon-msft commented Feb 4, 2026

Uh oh!

Copilot AI commented Feb 4, 2026

Uh oh!

dmichon-msft commented Feb 4, 2026

Uh oh!

Copilot AI commented Feb 4, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Copilot AI commented Feb 4, 2026 •

edited

Loading

dmichon-msft Feb 4, 2026 •

edited

Loading