Merge pull request microsoft#1323 from lahuey/master

iclanton · web-flow · commit d5c1756c805f · 2019-06-17T12:03:19.000-07:00
[rush-lib] Add ability to opt out of changelog files for version policies.
diff --git a/apps/rush-lib/assets/rush-init/common/config/rush/version-policies.json b/apps/rush-lib/assets/rush-init/common/config/rush/version-policies.json
@@ -77,7 +77,16 @@
      * inappropriately.  The minor/patch version parts will be bumped independently according
      * to the types of changes made to each project, according to the "rush change" command.
      */
-    "lockedMajor": 3
+    "lockedMajor": 3,
+
+    /**
+     * (Optional) When publishing is managed by Rush, by default the "rush change" command will
+     * request changes for any projects that are modified by a pull request. These change entries
+     * will produce a CHANGELOG.md file. If you author your CHANGELOG.md manually or announce updates
+     * in some other way, set "exemptFromRushChange" to true to tell "rush change" to ignore the projects
+     * belonging to this version policy.
+     */
+    "exemptFromRushChange": false
   }
   /*[END "DEMO"]*/
 ]
diff --git a/apps/rush-lib/src/api/VersionPolicy.ts b/apps/rush-lib/src/api/VersionPolicy.ts
@@ -52,6 +52,7 @@ export enum VersionPolicyDefinitionName {
 export abstract class VersionPolicy {
   private _policyName: string;
   private _definitionName: VersionPolicyDefinitionName;
+  private _exemptFromRushChange: boolean;
   private _versionFormatForCommit: VersionFormatForCommit;
   private _versionFormatForPublish: VersionFormatForPublish;
 
@@ -80,6 +81,7 @@ export abstract class VersionPolicy {
   constructor(versionPolicyJson: IVersionPolicyJson) {
     this._policyName = versionPolicyJson.policyName;
     this._definitionName = VersionPolicyDefinitionName[versionPolicyJson.definitionName];
+    this._exemptFromRushChange = versionPolicyJson.exemptFromRushChange || false;
 
     const jsonDependencies: IVersionPolicyDependencyJson = versionPolicyJson.dependencies || { };
     this._versionFormatForCommit = jsonDependencies.versionFormatForCommit || VersionFormatForCommit.original;
@@ -107,6 +109,13 @@ export abstract class VersionPolicy {
     return this.definitionName === VersionPolicyDefinitionName.lockStepVersion;
   }
 
+  /**
+   * Determines if a version policy wants to opt out of changelog files.
+   */
+  public get exemptFromRushChange(): boolean {
+    return this._exemptFromRushChange;
+  }
+
   /**
    * Returns an updated package json that satisfies the policy.
    *
diff --git a/apps/rush-lib/src/api/VersionPolicyConfiguration.ts b/apps/rush-lib/src/api/VersionPolicyConfiguration.ts
@@ -14,6 +14,7 @@ export interface IVersionPolicyJson {
   policyName: string;
   definitionName: string;
   dependencies?: IVersionPolicyDependencyJson;
+  exemptFromRushChange?: boolean;
 }
 
 /**
diff --git a/apps/rush-lib/src/cli/actions/ChangeAction.ts b/apps/rush-lib/src/cli/actions/ChangeAction.ts
@@ -173,6 +173,7 @@ export class ChangeAction extends BaseRushAction {
 
     this.rushConfiguration.projects
     .filter(project => project.shouldPublish)
+    .filter(project => !project.versionPolicy || !project.versionPolicy.exemptFromRushChange)
     .filter(project => this._hasProjectChanged(changedFolders, project))
     .forEach(project => {
       const hostName: string | undefined = this._projectHostMap.get(project.packageName);
diff --git a/apps/rush-lib/src/schemas/version-policies.schema.json b/apps/rush-lib/src/schemas/version-policies.schema.json
@@ -83,6 +83,10 @@
         "mainProject": {
           "description": "The main project for this version policy",
           "type": "string"
+        },
+        "exemptFromRushChange": {
+          "description": "If true, the version policy will not require changelog files.",
+          "type": "boolean"
         }
       },
       "required": ["policyName", "definitionName", "version", "nextBump"],
@@ -105,6 +109,10 @@
         "lockedMajor": {
           "description": "The locked major version",
           "type": "number"
+        },
+        "exemptFromRushChange": {
+          "description": "If true, the version policy will not require changelog files.",
+          "type": "boolean"
         }
       },
       "required": ["policyName", "definitionName"],
diff --git a/common/changes/@microsoft/rush/master_2019-06-07-00-24.json b/common/changes/@microsoft/rush/master_2019-06-07-00-24.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Add ability to opt out of changelog files for version policies.",
+      "packageName": "@microsoft/rush",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "lahuey@users.noreply.github.com"
+}
diff --git a/common/reviews/api/rush-lib.api.md b/common/reviews/api/rush-lib.api.md
@@ -331,6 +331,7 @@ export abstract class VersionPolicy {
     abstract bump(bumpType?: BumpType, identifier?: string): void;
     readonly definitionName: VersionPolicyDefinitionName;
     abstract ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined;
+    readonly exemptFromRushChange: boolean;
     readonly isLockstepped: boolean;
     // @internal
     abstract readonly _json: IVersionPolicyJson;

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ export interface IVersionPolicyJson {`
`14`	`14`	`policyName: string;`
`15`	`15`	`definitionName: string;`
`16`	`16`	`dependencies?: IVersionPolicyDependencyJson;`
	`17`	`+ exemptFromRushChange?: boolean;`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`/**`