Improve documentation of the build/rebuild change.

iclanton · iclanton · commit 9e123774aba3 · 2020-04-14T14:44:06.000-07:00
diff --git a/apps/rush-lib/assets/rush-init/common/config/rush/command-line.json b/apps/rush-lib/assets/rush-init/common/config/rush/command-line.json
@@ -29,6 +29,9 @@
        * The name should be comprised of lower case words separated by hyphens or colons. The name should include an
        * English verb (e.g. "deploy"). Use a hyphen to separate words (e.g. "upload-docs"). A group of related commands
        * can be prefixed with a colon (e.g. "docs:generate", "docs:deploy", "docs:serve", etc).
+       *
+       * Note that if the "rebuild" command is overridden here, it becomes separated from the "build" command
+       * and will call the "rebuild" script instead of the "build" script.
        */
       "name": "my-bulk-command",
 
diff --git a/common/changes/@microsoft/rush/ianc-rebuild_2020-04-11-01-02.json b/common/changes/@microsoft/rush/ianc-rebuild_2020-04-11-01-02.json
@@ -2,7 +2,7 @@
   "changes": [
     {
       "packageName": "@microsoft/rush",
-      "comment": "Fix a regression where an overridden \"rebuild\" script previously executed the \"rebuild\" script.",
+      "comment": "Fix a regression in Rush 5.19.0 where customizing \"rush rebuild\" would call the \"build\" script instead of the \"rebuild\" script.",
       "type": "none"
     }
   ],

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"changes": [`
`3`	`3`	`{`
`4`	`4`	`"packageName": "@microsoft/rush",`
`5`		`- "comment": "Fix a regression where an overridden \"rebuild\" script previously executed the \"rebuild\" script.",`
	`5`	`+ "comment": "Fix a regression in Rush 5.19.0 where customizing \"rush rebuild\" would call the \"build\" script instead of the \"rebuild\" script.",`
`6`	`6`	`"type": "none"`
`7`	`7`	`}`
`8`	`8`	`],`