Skip to content

Commit

Permalink
docs(core): github actions tutorial (nrwl#20319)
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacplmann authored Nov 20, 2023
1 parent dc3e140 commit 7368810
Show file tree
Hide file tree
Showing 12 changed files with 501 additions and 1 deletion.
30 changes: 30 additions & 0 deletions docs/generated/manifests/cloud.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@
"isExternal": false,
"path": "/nx-cloud/intro/tutorials/circle",
"tags": []
},
{
"id": "github-actions",
"name": "GitHub Actions with Nx",
"description": "",
"file": "nx-cloud/tutorial/github-actions",
"itemList": [],
"isExternal": false,
"path": "/nx-cloud/intro/tutorials/github-actions",
"tags": []
}
],
"isExternal": false,
Expand Down Expand Up @@ -66,6 +76,16 @@
"isExternal": false,
"path": "/nx-cloud/intro/tutorials/circle",
"tags": []
},
{
"id": "github-actions",
"name": "GitHub Actions with Nx",
"description": "",
"file": "nx-cloud/tutorial/github-actions",
"itemList": [],
"isExternal": false,
"path": "/nx-cloud/intro/tutorials/github-actions",
"tags": []
}
],
"isExternal": false,
Expand All @@ -82,6 +102,16 @@
"path": "/nx-cloud/intro/tutorials/circle",
"tags": []
},
"/nx-cloud/intro/tutorials/github-actions": {
"id": "github-actions",
"name": "GitHub Actions with Nx",
"description": "",
"file": "nx-cloud/tutorial/github-actions",
"itemList": [],
"isExternal": false,
"path": "/nx-cloud/intro/tutorials/github-actions",
"tags": []
},
"/nx-cloud/features": {
"id": "features",
"name": "Features",
Expand Down
24 changes: 24 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -5546,6 +5546,14 @@
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "GitHub Actions with Nx",
"path": "/nx-cloud/intro/tutorials/github-actions",
"id": "github-actions",
"isExternal": false,
"children": [],
"disableCollapsible": false
}
],
"disableCollapsible": false
Expand Down Expand Up @@ -5574,6 +5582,14 @@
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "GitHub Actions with Nx",
"path": "/nx-cloud/intro/tutorials/github-actions",
"id": "github-actions",
"isExternal": false,
"children": [],
"disableCollapsible": false
}
],
"disableCollapsible": false
Expand All @@ -5586,6 +5602,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "GitHub Actions with Nx",
"path": "/nx-cloud/intro/tutorials/github-actions",
"id": "github-actions",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Features",
"path": "/nx-cloud/features",
Expand Down
5 changes: 5 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -1647,6 +1647,11 @@
"name": "Circle CI with Nx",
"id": "circle",
"file": "nx-cloud/tutorial/circle"
},
{
"name": "GitHub Actions with Nx",
"id": "github-actions",
"file": "nx-cloud/tutorial/github-actions"
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion docs/nx-cloud/tutorial/circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ Once Circle CI starts, you should see multiple agents running in parallel:

If you open your Nx Cloud dashboard, you'll get a better view of the individual tasks and their corresponding logs.

![Nx Cloud run details](/nx-cloud/tutorial/circle-nx-cloud-run-details.png)
![Nx Cloud run details](/nx-cloud/tutorial/nx-cloud-run-details.png)

With this pipeline configuration in place, no matter how large the repository scales, Nx Cloud will adjust and distribute tasks across agents in the optimal way. If CI pipelines start to slow down, just add some agents to the `ordinal: [1, 2, 3]` array. One of the main advantages is that such a pipeline definition is declarative. We just give instructions what commands to run, but not how to distribute them. As such even if our monorepo structure changes and evolves over time, the distribution will be taken care of by Nx Cloud.

Expand Down
Binary file added docs/nx-cloud/tutorial/gh-ci-remote-cache.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nx-cloud/tutorial/gh-dte-multiple-agents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nx-cloud/tutorial/gh-message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nx-cloud/tutorial/gh-pr-passed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7368810

Please sign in to comment.