Merge pull request #3174 from iclanton/upgrading-links

[rush] Include links to UPGRADING.md
microsoft · Jan 20, 2022 · 56f40b5 · 56f40b5
2 parents 7403690 + 9a344dc
commit 56f40b5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/apps/rush-lib/src/api/RushProjectConfiguration.ts b/apps/rush-lib/src/api/RushProjectConfiguration.ts
@@ -278,7 +278,8 @@ export class RushProjectConfiguration {
       ) {
         throw new Error(
           `The ${RUSH_PROJECT_CONFIGURATION_FILE.projectRelativeFilePath} file appears to be ` +
-            'in an outdated format. Please see the UPGRADING.md file in the Rush project for upgrade instructions.'
+            'in an outdated format. Please see the UPGRADING.md notes for details. ' +
+            'Quick link: https://rushjs.io/link/upgrading'
         );
       } else {
         throw e;

diff --git a/apps/rush/README.md b/apps/rush/README.md
@@ -69,6 +69,9 @@ For more details and support resources, please visit: https://rushjs.io
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/master/apps/rush/CHANGELOG.md) - Find
   out what's new in the latest version
+- [UPGRADING.md](
+  https://github.com/microsoft/rushstack/blob/master/apps/rush/UPGRADING.md) - Instructions
+  for migrating existing projects to use a newer version of Rush
 - [API Reference](https://rushstack.io/pages/api/rush-lib/)
 
 Rush is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/common/changes/@microsoft/rush/upgrading-links_2022-01-20-01-28.json b/common/changes/@microsoft/rush/upgrading-links_2022-01-20-01-28.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "",
+      "type": "none",
+      "packageName": "@microsoft/rush"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "[email protected]"
+}