Merge branch 'master' into version-plans-messages

nrwl · Aug 7, 2024 · cd2298e · cd2298e
2 parents 059fb75 + 40d3516
commit cd2298e
Show file tree

Hide file tree

Showing 70 changed files with 4,257 additions and 1,461 deletions.
diff --git a/docs/generated/cli/release.md b/docs/generated/cli/release.md
@@ -37,6 +37,12 @@ Type: `boolean`
 
 Show help
 
+### printConfig
+
+Type: `string`
+
+Print the resolved nx release configuration that would be used for the current command and then exit
+
 ### projects
 
 Type: `string`

diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json
@@ -1922,6 +1922,14 @@
                 "children": [],
                 "disableCollapsible": false
               },
+              {
+                "name": "Customize Conventional Commit Types",
+                "path": "/recipes/nx-release/customize-conventional-commit-types",
+                "id": "customize-conventional-commit-types",
+                "isExternal": false,
+                "children": [],
+                "disableCollapsible": false
+              },
               {
                 "name": "Configure Custom Registries",
                 "path": "/recipes/nx-release/configure-custom-registries",
@@ -1962,14 +1970,6 @@
                 "children": [],
                 "disableCollapsible": false
               },
-              {
-                "name": "Customize Conventional Commit Types",
-                "path": "/recipes/nx-release/customize-conventional-commit-types",
-                "id": "customize-conventional-commit-types",
-                "isExternal": false,
-                "children": [],
-                "disableCollapsible": false
-              },
               {
                 "name": "Configure Changelog Format",
                 "path": "/recipes/nx-release/configure-changelog-format",
@@ -3625,6 +3625,14 @@
             "children": [],
             "disableCollapsible": false
           },
+          {
+            "name": "Customize Conventional Commit Types",
+            "path": "/recipes/nx-release/customize-conventional-commit-types",
+            "id": "customize-conventional-commit-types",
+            "isExternal": false,
+            "children": [],
+            "disableCollapsible": false
+          },
           {
             "name": "Configure Custom Registries",
             "path": "/recipes/nx-release/configure-custom-registries",
@@ -3665,14 +3673,6 @@
             "children": [],
             "disableCollapsible": false
           },
-          {
-            "name": "Customize Conventional Commit Types",
-            "path": "/recipes/nx-release/customize-conventional-commit-types",
-            "id": "customize-conventional-commit-types",
-            "isExternal": false,
-            "children": [],
-            "disableCollapsible": false
-          },
           {
             "name": "Configure Changelog Format",
             "path": "/recipes/nx-release/configure-changelog-format",
@@ -3716,6 +3716,14 @@
         "children": [],
         "disableCollapsible": false
       },
+      {
+        "name": "Customize Conventional Commit Types",
+        "path": "/recipes/nx-release/customize-conventional-commit-types",
+        "id": "customize-conventional-commit-types",
+        "isExternal": false,
+        "children": [],
+        "disableCollapsible": false
+      },
       {
         "name": "Configure Custom Registries",
         "path": "/recipes/nx-release/configure-custom-registries",
@@ -3756,14 +3764,6 @@
         "children": [],
         "disableCollapsible": false
       },
-      {
-        "name": "Customize Conventional Commit Types",
-        "path": "/recipes/nx-release/customize-conventional-commit-types",
-        "id": "customize-conventional-commit-types",
-        "isExternal": false,
-        "children": [],
-        "disableCollapsible": false
-      },
       {
         "name": "Configure Changelog Format",
         "path": "/recipes/nx-release/configure-changelog-format",

diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json
@@ -2626,6 +2626,17 @@
             "path": "/recipes/nx-release/automatically-version-with-conventional-commits",
             "tags": ["nx-release"]
           },
+          {
+            "id": "customize-conventional-commit-types",
+            "name": "Customize Conventional Commit Types",
+            "description": "",
+            "mediaImage": "",
+            "file": "shared/recipes/nx-release/customize-conventional-commit-types",
+            "itemList": [],
+            "isExternal": false,
+            "path": "/recipes/nx-release/customize-conventional-commit-types",
+            "tags": ["nx-release"]
+          },
           {
             "id": "configure-custom-registries",
             "name": "Configure Custom Registries",
@@ -2681,17 +2692,6 @@
             "path": "/recipes/nx-release/update-local-registry-setup",
             "tags": ["nx-release"]
           },
-          {
-            "id": "customize-conventional-commit-types",
-            "name": "Customize Conventional Commit Types",
-            "description": "",
-            "mediaImage": "",
-            "file": "shared/recipes/nx-release/customize-conventional-commit-types",
-            "itemList": [],
-            "isExternal": false,
-            "path": "/recipes/nx-release/customize-conventional-commit-types",
-            "tags": ["nx-release"]
-          },
           {
             "id": "configure-changelog-format",
             "name": "Configure Changelog Format",
@@ -4961,6 +4961,17 @@
         "path": "/recipes/nx-release/automatically-version-with-conventional-commits",
         "tags": ["nx-release"]
       },
+      {
+        "id": "customize-conventional-commit-types",
+        "name": "Customize Conventional Commit Types",
+        "description": "",
+        "mediaImage": "",
+        "file": "shared/recipes/nx-release/customize-conventional-commit-types",
+        "itemList": [],
+        "isExternal": false,
+        "path": "/recipes/nx-release/customize-conventional-commit-types",
+        "tags": ["nx-release"]
+      },
       {
         "id": "configure-custom-registries",
         "name": "Configure Custom Registries",
@@ -5016,17 +5027,6 @@
         "path": "/recipes/nx-release/update-local-registry-setup",
         "tags": ["nx-release"]
       },
-      {
-        "id": "customize-conventional-commit-types",
-        "name": "Customize Conventional Commit Types",
-        "description": "",
-        "mediaImage": "",
-        "file": "shared/recipes/nx-release/customize-conventional-commit-types",
-        "itemList": [],
-        "isExternal": false,
-        "path": "/recipes/nx-release/customize-conventional-commit-types",
-        "tags": ["nx-release"]
-      },
       {
         "id": "configure-changelog-format",
         "name": "Configure Changelog Format",
@@ -5087,6 +5087,17 @@
     "path": "/recipes/nx-release/automatically-version-with-conventional-commits",
     "tags": ["nx-release"]
   },
+  "/recipes/nx-release/customize-conventional-commit-types": {
+    "id": "customize-conventional-commit-types",
+    "name": "Customize Conventional Commit Types",
+    "description": "",
+    "mediaImage": "",
+    "file": "shared/recipes/nx-release/customize-conventional-commit-types",
+    "itemList": [],
+    "isExternal": false,
+    "path": "/recipes/nx-release/customize-conventional-commit-types",
+    "tags": ["nx-release"]
+  },
   "/recipes/nx-release/configure-custom-registries": {
     "id": "configure-custom-registries",
     "name": "Configure Custom Registries",
@@ -5142,17 +5153,6 @@
     "path": "/recipes/nx-release/update-local-registry-setup",
     "tags": ["nx-release"]
   },
-  "/recipes/nx-release/customize-conventional-commit-types": {
-    "id": "customize-conventional-commit-types",
-    "name": "Customize Conventional Commit Types",
-    "description": "",
-    "mediaImage": "",
-    "file": "shared/recipes/nx-release/customize-conventional-commit-types",
-    "itemList": [],
-    "isExternal": false,
-    "path": "/recipes/nx-release/customize-conventional-commit-types",
-    "tags": ["nx-release"]
-  },
   "/recipes/nx-release/configure-changelog-format": {
     "id": "configure-changelog-format",
     "name": "Configure Changelog Format",

diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json
@@ -483,6 +483,13 @@
       "name": "Automatically Version with Conventional Commits",
       "path": "/recipes/nx-release/automatically-version-with-conventional-commits"
     },
+    {
+      "description": "",
+      "file": "shared/recipes/nx-release/customize-conventional-commit-types",
+      "id": "customize-conventional-commit-types",
+      "name": "Customize Conventional Commit Types",
+      "path": "/recipes/nx-release/customize-conventional-commit-types"
+    },
     {
       "description": "",
       "file": "shared/recipes/nx-release/configure-custom-registries",
@@ -518,13 +525,6 @@
       "name": "Update Your Local Registry Setup to use Nx Release",
       "path": "/recipes/nx-release/update-local-registry-setup"
     },
-    {
-      "description": "",
-      "file": "shared/recipes/nx-release/customize-conventional-commit-types",
-      "id": "customize-conventional-commit-types",
-      "name": "Customize Conventional Commit Types",
-      "path": "/recipes/nx-release/customize-conventional-commit-types"
-    },
     {
       "description": "",
       "file": "shared/recipes/nx-release/configure-changelog-format",

diff --git a/docs/generated/packages/nx/documents/release.md b/docs/generated/packages/nx/documents/release.md
@@ -37,6 +37,12 @@ Type: `boolean`
 
 Show help
 
+### printConfig
+
+Type: `string`
+
+Print the resolved nx release configuration that would be used for the current command and then exit
+
 ### projects
 
 Type: `string`

diff --git a/docs/map.json b/docs/map.json
@@ -998,6 +998,12 @@
                   "tags": ["nx-release"],
                   "file": "shared/recipes/nx-release/automatically-version-with-conventional-commits"
                 },
+                {
+                  "name": "Customize Conventional Commit Types",
+                  "id": "customize-conventional-commit-types",
+                  "tags": ["nx-release"],
+                  "file": "shared/recipes/nx-release/customize-conventional-commit-types"
+                },
                 {
                   "name": "Configure Custom Registries",
                   "id": "configure-custom-registries",
@@ -1028,12 +1034,6 @@
                   "tags": ["nx-release"],
                   "file": "shared/recipes/nx-release/update-local-registry-setup"
                 },
-                {
-                  "name": "Customize Conventional Commit Types",
-                  "id": "customize-conventional-commit-types",
-                  "tags": ["nx-release"],
-                  "file": "shared/recipes/nx-release/customize-conventional-commit-types"
-                },
                 {
                   "name": "Configure Changelog Format",
                   "id": "configure-changelog-format",

diff --git a/docs/nx-cloud/intro/connect-to-cloud.md b/docs/nx-cloud/intro/connect-to-cloud.md
@@ -4,41 +4,42 @@ Nx Cloud directly integrates with your existing CI setup.
 
 ![Nx Cloud Overview](/shared/images/nx-cloud/nx-cloud-overview.webp)
 
-In a nutshell, here's how this works:
+Here's how you get set up.
 
-**Step 1: Connect your workspace to Nx Cloud**
+## Step 1: Connect your workspace to Nx Cloud
 
-This can be done by signing up on [nx.app](https://nx.app) and then connecting to your git repository.
+To connect your workspace, **push it to GitHub** (or your respective source control provider) and then run:
 
 ```shell
 npx nx connect
 ```
 
-**Step 2: Your CI script triggers Nx Cloud**
+## Step 2: Configure your CI script
+
+If you have CI set up already, configure [distribution with Nx Agents](/ci/features/distribute-task-execution) as follows:
 
 ```yml
 - name: Start CI run
   run: 'npx nx-cloud start-ci-run --distribute-on="8 linux-medium-js"'
 ```
 
-Let us generate the workflow file for you, if you don't already have one.
+Alternatively you can generate the CI configuration using:
 
 ```shell
 npx nx g ci-workflow
 ```
 
 Or, check out our [recipes for the various CI providers](/ci/recipes/set-up).
 
-**Step 3: Run your Nx commands as usual**
+## Step 3: Run your Nx commands as usual
 
 ```yml
 - run: npx nx-cloud record -- node tools/custom-script.js
-- run: npx nx affected -t lint test build
-- run: npx nx affected -t e2e-ci --parallel 1
+- run: npx nx affected -t lint test build e2e-ci
 ```
 
 All these commands are automatically picked up by Nx Cloud, split up into smaller tasks and distributed across the specified number of machines. Nx Cloud works with Nx tasks automatically, or you can [record non-Nx commands with `nx-cloud record`](/ci/recipes/other/record-commands).
 
-**Step 4: All results are played back automatically**
+## Step 4: All results are played back automatically
 
 Nx Cloud automatically plays back all results to your CI system, as if distribution never happened. You can continue doing post-processing on the results, like uploading test reports, deploying artifacts etc.