[rush] Fix version bump removing policy fields

Author: dmichon-msft

common/changes/@microsoft/rush/version-policy-exempt_2025-08-19-21-32.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Ensure that `rush version` and `rush publish` preserve all fields in `version-policies-json`.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/reviews/api/rush-lib.api.md

@@ -575,15 +575,15 @@ export interface ILogger {
 
 // @public
 export class IndividualVersionPolicy extends VersionPolicy {
-    // Warning: (ae-forgotten-export) The symbol "IIndividualVersionJson" needs to be exported by the entry point index.d.ts
-    //
     // @internal
     constructor(versionPolicyJson: IIndividualVersionJson);
     bump(bumpType?: BumpType, identifier?: string): void;
     ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined;
-    // @internal
-    get _json(): IIndividualVersionJson;
-    readonly lockedMajor: number | undefined;
+    // Warning: (ae-forgotten-export) The symbol "IIndividualVersionJson" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    readonly _json: IIndividualVersionJson;
+    get lockedMajor(): number | undefined;
     validate(versionString: string, packageName: string): void;
 }
 
@@ -929,16 +929,16 @@ export interface _IYarnOptionsJson extends IPackageManagerOptionsJsonBase {
 
 // @public
 export class LockStepVersionPolicy extends VersionPolicy {
-    // Warning: (ae-forgotten-export) The symbol "ILockStepVersionJson" needs to be exported by the entry point index.d.ts
-    //
     // @internal
     constructor(versionPolicyJson: ILockStepVersionJson);
     bump(bumpType?: BumpType, identifier?: string): void;
     ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined;
-    // @internal
-    get _json(): ILockStepVersionJson;
-    readonly mainProject: string | undefined;
-    readonly nextBump: BumpType | undefined;
+    // Warning: (ae-forgotten-export) The symbol "ILockStepVersionJson" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    _json: ILockStepVersionJson;
+    get mainProject(): string | undefined;
+    get nextBump(): BumpType | undefined;
     update(newVersionString: string): boolean;
     validate(versionString: string, packageName: string): void;
     get version(): string;
@@ -1603,21 +1603,21 @@ export class SubspacesConfiguration {
 
 // @public
 export abstract class VersionPolicy {
-    // Warning: (ae-forgotten-export) The symbol "IVersionPolicyJson" needs to be exported by the entry point index.d.ts
-    //
     // @internal
     constructor(versionPolicyJson: IVersionPolicyJson);
     abstract bump(bumpType?: BumpType, identifier?: string): void;
-    readonly definitionName: VersionPolicyDefinitionName;
+    get definitionName(): VersionPolicyDefinitionName;
     abstract ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined;
-    readonly exemptFromRushChange: boolean;
-    readonly includeEmailInChangeFile: boolean;
+    get exemptFromRushChange(): boolean;
+    get includeEmailInChangeFile(): boolean;
     get isLockstepped(): boolean;
+    // Warning: (ae-forgotten-export) The symbol "IVersionPolicyJson" needs to be exported by the entry point index.d.ts
+    //
     // @internal
-    abstract get _json(): IVersionPolicyJson;
+    readonly _json: IVersionPolicyJson;
     // @internal
     static load(versionPolicyJson: IVersionPolicyJson): VersionPolicy | undefined;
-    readonly policyName: string;
+    get policyName(): string;
     setDependenciesBeforeCommit(packageName: string, configuration: RushConfiguration): void;
     setDependenciesBeforePublish(packageName: string, configuration: RushConfiguration): void;
     abstract validate(versionString: string, packageName: string): void;

libraries/rush-lib/src/api/VersionPolicy.ts

@@ -9,8 +9,7 @@ import {
   type ILockStepVersionJson,
   type IIndividualVersionJson,
   VersionFormatForCommit,
-  VersionFormatForPublish,
-  type IVersionPolicyDependencyJson
+  VersionFormatForPublish
 } from './VersionPolicyConfiguration';
 import type { PackageJsonEditor } from './PackageJsonEditor';
 import type { RushConfiguration } from './RushConfiguration';
@@ -57,42 +56,54 @@ export enum VersionPolicyDefinitionName {
  * @public
  */
 export abstract class VersionPolicy {
-  private _versionFormatForCommit: VersionFormatForCommit;
-  private _versionFormatForPublish: VersionFormatForPublish;
+  /**
+   * Serialized json for the policy
+   *
+   * @internal
+   */
+  public readonly _json: IVersionPolicyJson;
+
+  private get _versionFormatForCommit(): VersionFormatForCommit {
+    return this._json.dependencies?.versionFormatForCommit ?? VersionFormatForCommit.original;
+  }
+
+  private get _versionFormatForPublish(): VersionFormatForPublish {
+    return this._json.dependencies?.versionFormatForPublish ?? VersionFormatForPublish.original;
+  }
 
   /**
    * Version policy name
    */
-  public readonly policyName: string;
+  public get policyName(): string {
+    return this._json.policyName;
+  }
 
   /**
    * Version policy definition name
    */
-  public readonly definitionName: VersionPolicyDefinitionName;
+  public get definitionName(): VersionPolicyDefinitionName {
+    return Enum.getValueByKey(VersionPolicyDefinitionName, this._json.definitionName);
+  }
 
   /**
    * Determines if a version policy wants to opt out of changelog files.
    */
-  public readonly exemptFromRushChange: boolean;
+  public get exemptFromRushChange(): boolean {
+    return this._json.exemptFromRushChange ?? false;
+  }
 
   /**
    * Determines if a version policy wants to opt in to including email.
    */
-  public readonly includeEmailInChangeFile: boolean;
+  public get includeEmailInChangeFile(): boolean {
+    return this._json.includeEmailInChangeFile ?? false;
+  }
 
   /**
    * @internal
    */
   public constructor(versionPolicyJson: IVersionPolicyJson) {
-    this.policyName = versionPolicyJson.policyName;
-    this.definitionName = Enum.getValueByKey(VersionPolicyDefinitionName, versionPolicyJson.definitionName);
-    this.exemptFromRushChange = versionPolicyJson.exemptFromRushChange || false;
-    this.includeEmailInChangeFile = versionPolicyJson.includeEmailInChangeFile || false;
-
-    const jsonDependencies: IVersionPolicyDependencyJson = versionPolicyJson.dependencies || {};
-    this._versionFormatForCommit = jsonDependencies.versionFormatForCommit || VersionFormatForCommit.original;
-    this._versionFormatForPublish =
-      jsonDependencies.versionFormatForPublish || VersionFormatForPublish.original;
+    this._json = versionPolicyJson;
   }
 
   /**
@@ -140,13 +151,6 @@ export abstract class VersionPolicy {
    */
   public abstract bump(bumpType?: BumpType, identifier?: string): void;
 
-  /**
-   * Serialized json for the policy
-   *
-   * @internal
-   */
-  public abstract get _json(): IVersionPolicyJson;
-
   /**
    * Validates the specified version and throws if the version does not satisfy the policy.
    *
@@ -211,34 +215,34 @@ export abstract class VersionPolicy {
  * @public
  */
 export class LockStepVersionPolicy extends VersionPolicy {
+  public declare _json: ILockStepVersionJson;
   private _version: semver.SemVer;
 
   /**
    * The type of bump for next bump.
    */
   // nextBump is probably not needed. It can be prerelease only.
   // Other types of bumps can be passed in as a parameter to bump method, so can identifier.
-  public readonly nextBump: BumpType | undefined;
+  public get nextBump(): BumpType | undefined {
+    return this._json.nextBump !== undefined ? Enum.getValueByKey(BumpType, this._json.nextBump) : undefined;
+  }
 
   /**
    * The main project for the version policy.
    *
    * If the value is provided, change logs will only be generated in that project.
    * If the value is not provided, change logs will be hosted in each project associated with the policy.
    */
-  public readonly mainProject: string | undefined;
+  public get mainProject(): string | undefined {
+    return this._json.mainProject;
+  }
 
   /**
    * @internal
    */
   public constructor(versionPolicyJson: ILockStepVersionJson) {
     super(versionPolicyJson);
     this._version = new semver.SemVer(versionPolicyJson.version);
-    this.nextBump =
-      versionPolicyJson.nextBump !== undefined
-        ? Enum.getValueByKey(BumpType, versionPolicyJson.nextBump)
-        : undefined;
-    this.mainProject = versionPolicyJson.mainProject;
   }
 
   /**
@@ -248,26 +252,6 @@ export class LockStepVersionPolicy extends VersionPolicy {
     return this._version.format();
   }
 
-  /**
-   * Serialized json for this policy
-   *
-   * @internal
-   */
-  public get _json(): ILockStepVersionJson {
-    const json: ILockStepVersionJson = {
-      policyName: this.policyName,
-      definitionName: VersionPolicyDefinitionName[this.definitionName],
-      version: this.version
-    };
-    if (this.nextBump !== undefined) {
-      json.nextBump = BumpType[this.nextBump];
-    }
-    if (this.mainProject !== undefined) {
-      json.mainProject = this.mainProject;
-    }
-    return json;
-  }
-
   /**
    * Returns an updated package json that satisfies the version policy.
    *
@@ -303,6 +287,7 @@ export class LockStepVersionPolicy extends VersionPolicy {
     }
 
     this._version.inc(this._getReleaseType(nextBump), identifier);
+    this._json.version = this.version;
   }
 
   /**
@@ -315,6 +300,7 @@ export class LockStepVersionPolicy extends VersionPolicy {
       return false;
     }
     this._version = newVersion;
+    this._json.version = this.version;
     return true;
   }
 
@@ -348,33 +334,20 @@ export class LockStepVersionPolicy extends VersionPolicy {
  * @public
  */
 export class IndividualVersionPolicy extends VersionPolicy {
+  public declare readonly _json: IIndividualVersionJson;
+
   /**
    * The major version that has been locked
    */
-  public readonly lockedMajor: number | undefined;
+  public get lockedMajor(): number | undefined {
+    return this._json.lockedMajor;
+  }
 
   /**
    * @internal
    */
   public constructor(versionPolicyJson: IIndividualVersionJson) {
     super(versionPolicyJson);
-    this.lockedMajor = versionPolicyJson.lockedMajor;
-  }
-
-  /**
-   * Serialized json for this policy
-   *
-   * @internal
-   */
-  public get _json(): IIndividualVersionJson {
-    const json: IIndividualVersionJson = {
-      policyName: this.policyName,
-      definitionName: VersionPolicyDefinitionName[this.definitionName]
-    };
-    if (this.lockedMajor !== undefined) {
-      json.lockedMajor = this.lockedMajor;
-    }
-    return json;
   }
 
   /**

libraries/rush-lib/src/api/test/VersionPolicy.test.ts

@@ -3,7 +3,13 @@
 
 import type { IPackageJson } from '@rushstack/node-core-library';
 
-import { VersionPolicyConfiguration } from '../VersionPolicyConfiguration';
+import {
+  type ILockStepVersionJson,
+  VersionFormatForCommit,
+  VersionFormatForPublish,
+  VersionPolicyConfiguration,
+  type IIndividualVersionJson
+} from '../VersionPolicyConfiguration';
 import { VersionPolicy, LockStepVersionPolicy, IndividualVersionPolicy, BumpType } from '../VersionPolicy';
 
 describe(VersionPolicy.name, () => {
@@ -113,6 +119,25 @@ describe(VersionPolicy.name, () => {
       lockStepVersionPolicy.update(newVersion);
       expect(lockStepVersionPolicy.version).toEqual(newVersion);
     });
+
+    it('preserves fields', () => {
+      const originalJson: ILockStepVersionJson = {
+        definitionName: 'lockStepVersion',
+        policyName: 'test',
+        dependencies: {
+          versionFormatForCommit: VersionFormatForCommit.original,
+          versionFormatForPublish: VersionFormatForPublish.original
+        },
+        exemptFromRushChange: true,
+        includeEmailInChangeFile: true,
+        version: '1.1.0',
+        mainProject: 'main-project',
+        nextBump: 'major'
+      };
+
+      const nextJson: ILockStepVersionJson = new LockStepVersionPolicy(originalJson)._json;
+      expect(nextJson).toMatchObject(originalJson);
+    });
   });
 
   describe(IndividualVersionPolicy.name, () => {
@@ -159,5 +184,22 @@ describe(VersionPolicy.name, () => {
         individualVersionPolicy.ensure(originalPackageJson);
       }).toThrow();
     });
+
+    it('preserves fields', () => {
+      const originalJson: IIndividualVersionJson = {
+        definitionName: 'individualVersion',
+        policyName: 'test',
+        dependencies: {
+          versionFormatForCommit: VersionFormatForCommit.original,
+          versionFormatForPublish: VersionFormatForPublish.original
+        },
+        exemptFromRushChange: true,
+        includeEmailInChangeFile: true,
+        lockedMajor: 3
+      };
+
+      const nextJson: IIndividualVersionJson = new IndividualVersionPolicy(originalJson)._json;
+      expect(nextJson).toMatchObject(originalJson);
+    });
   });
 });