diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index 3c407f3716..ec2ba492ef 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -1454,6 +1454,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Nx Cloud Integration", + "path": "/recipes/nx-console/console-nx-cloud", + "id": "console-nx-cloud", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Troubleshooting", "path": "/recipes/nx-console/console-troubleshooting", @@ -2739,6 +2747,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Nx Cloud Integration", + "path": "/recipes/nx-console/console-nx-cloud", + "id": "console-nx-cloud", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Troubleshooting", "path": "/recipes/nx-console/console-troubleshooting", @@ -2782,6 +2798,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Nx Cloud Integration", + "path": "/recipes/nx-console/console-nx-cloud", + "id": "console-nx-cloud", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Troubleshoot Nx Console Issues", "path": "/recipes/nx-console/console-troubleshooting", diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json index e509e5b145..334739d018 100644 --- a/docs/generated/manifests/nx.json +++ b/docs/generated/manifests/nx.json @@ -1992,6 +1992,17 @@ "path": "/recipes/nx-console/console-run-command", "tags": ["editor-setup"] }, + { + "id": "console-nx-cloud", + "name": "Nx Cloud Integration", + "description": "", + "mediaImage": "", + "file": "shared/recipes/console-nx-cloud", + "itemList": [], + "isExternal": false, + "path": "/recipes/nx-console/console-nx-cloud", + "tags": ["editor-setup"] + }, { "id": "console-troubleshooting", "name": "Troubleshooting", @@ -3753,6 +3764,17 @@ "path": "/recipes/nx-console/console-run-command", "tags": ["editor-setup"] }, + { + "id": "console-nx-cloud", + "name": "Nx Cloud Integration", + "description": "", + "mediaImage": "", + "file": "shared/recipes/console-nx-cloud", + "itemList": [], + "isExternal": false, + "path": "/recipes/nx-console/console-nx-cloud", + "tags": ["editor-setup"] + }, { "id": "console-troubleshooting", "name": "Troubleshooting", @@ -3813,6 +3835,17 @@ "path": "/recipes/nx-console/console-run-command", "tags": ["editor-setup"] }, + "/recipes/nx-console/console-nx-cloud": { + "id": "console-nx-cloud", + "name": "Nx Cloud Integration", + "description": "", + "mediaImage": "", + "file": "shared/recipes/console-nx-cloud", + "itemList": [], + "isExternal": false, + "path": "/recipes/nx-console/console-nx-cloud", + "tags": ["editor-setup"] + }, "/recipes/nx-console/console-troubleshooting": { "id": "console-troubleshooting", "name": "Troubleshoot Nx Console Issues", diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json index 46e56bf51c..760b98726a 100644 --- a/docs/generated/manifests/tags.json +++ b/docs/generated/manifests/tags.json @@ -34,6 +34,13 @@ "id": "console-run-command", "name": "Run Command", "path": "/recipes/nx-console/console-run-command" + }, + { + "description": "", + "file": "shared/recipes/console-nx-cloud", + "id": "console-nx-cloud", + "name": "Nx Cloud Integration", + "path": "/recipes/nx-console/console-nx-cloud" } ], "run-tasks": [ diff --git a/docs/map.json b/docs/map.json index b14c0a6ba4..fd460981bd 100644 --- a/docs/map.json +++ b/docs/map.json @@ -633,6 +633,12 @@ "tags": ["editor-setup"], "file": "shared/recipes/console-run-command" }, + { + "name": "Nx Cloud Integration", + "id": "console-nx-cloud", + "tags": ["editor-setup"], + "file": "shared/recipes/console-nx-cloud" + }, { "name": "Troubleshooting", "id": "console-troubleshooting", diff --git a/docs/shared/images/nx-console/cloud-notification.png b/docs/shared/images/nx-console/cloud-notification.png new file mode 100644 index 0000000000..9f2fce00b8 Binary files /dev/null and b/docs/shared/images/nx-console/cloud-notification.png differ diff --git a/docs/shared/images/nx-console/cloud-view.png b/docs/shared/images/nx-console/cloud-view.png new file mode 100644 index 0000000000..b20511dc2e Binary files /dev/null and b/docs/shared/images/nx-console/cloud-view.png differ diff --git a/docs/shared/recipes/console-nx-cloud.md b/docs/shared/recipes/console-nx-cloud.md new file mode 100644 index 0000000000..8ffcde4e6e --- /dev/null +++ b/docs/shared/recipes/console-nx-cloud.md @@ -0,0 +1,25 @@ +# Nx Console & Nx Cloud Integration + +Nx Console for VSCode is integrated with Nx Cloud to help you stay on top of your CI Pipelines without leaving the editor. + +If your workspace is connected to Nx Cloud, you will have access to a new view in the Nx Console sidebar that provides at-a-glance information about your running and recent CI pipeline executions. + +![Nx Console Nx Cloud View](/shared/images/nx-console/cloud-view.png) + +{% callout type="note" %} +Nx Console will only show information about CI Pipelines from the last hour and triggered from branches that you have modified locally. If you want to see information about other pipelines, use the Nx Cloud application at [cloud.nx.app](https://cloud.nx.app). +{% /callout %} + +## Notifications + +In addition to the view, you will receive notifications when a pipeline completes or a task in it fails. + +![Nx Console Nx Cloud Notifications](/shared/images/nx-console/cloud-notification.png) + +You can click on the buttons to view the results directly in Nx Cloud or open the Pull Request in the browser. + +To only be notified on failure or turn off notifications altogether, you can change the `nxConsole.nxCloudNotifications` setting. + +## JetBrains + +This feature is only available in VSCode but coming soon to JetBrains. For now, you can see whether you're connected to Nx Cloud and navigate directly to the Nx Cloud application from the Nx Console Toolwindow. diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index 9293ef9396..9c07541de9 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -97,6 +97,7 @@ - [Project Details View](/recipes/nx-console/console-project-details) - [Generate Command](/recipes/nx-console/console-generate-command) - [Run Command](/recipes/nx-console/console-run-command) + - [Nx Cloud Integration](/recipes/nx-console/console-nx-cloud) - [Troubleshooting](/recipes/nx-console/console-troubleshooting) - [React](/recipes/react) - [React Native with Nx](/recipes/react/react-native)