docs(misc): add docs for Nx Console & Nx Cloud integration (#29401)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #

---------

Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
This commit is contained in:
MaxKless 2024-12-18 15:27:01 +01:00 committed by GitHub
parent 6051e6e208
commit b1303d1121
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 96 additions and 0 deletions

View File

@ -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",

View File

@ -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",

View File

@ -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": [

View File

@ -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",

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

View File

@ -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.

View File

@ -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)