docs(nx-cloud): add basic Azure DevOps setup recipe
@ -569,6 +569,17 @@
|
|||||||
"isExternal": false,
|
"isExternal": false,
|
||||||
"path": "/ci/recipes/source-control-integration/gitlab",
|
"path": "/ci/recipes/source-control-integration/gitlab",
|
||||||
"tags": []
|
"tags": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "azure-devops",
|
||||||
|
"name": "Enable Azure DevOps PR Integration",
|
||||||
|
"description": "",
|
||||||
|
"mediaImage": "",
|
||||||
|
"file": "nx-cloud/set-up/azure-devops",
|
||||||
|
"itemList": [],
|
||||||
|
"isExternal": false,
|
||||||
|
"path": "/ci/recipes/source-control-integration/azure-devops",
|
||||||
|
"tags": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"isExternal": false,
|
"isExternal": false,
|
||||||
@ -1110,6 +1121,17 @@
|
|||||||
"isExternal": false,
|
"isExternal": false,
|
||||||
"path": "/ci/recipes/source-control-integration/gitlab",
|
"path": "/ci/recipes/source-control-integration/gitlab",
|
||||||
"tags": []
|
"tags": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "azure-devops",
|
||||||
|
"name": "Enable Azure DevOps PR Integration",
|
||||||
|
"description": "",
|
||||||
|
"mediaImage": "",
|
||||||
|
"file": "nx-cloud/set-up/azure-devops",
|
||||||
|
"itemList": [],
|
||||||
|
"isExternal": false,
|
||||||
|
"path": "/ci/recipes/source-control-integration/azure-devops",
|
||||||
|
"tags": []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"isExternal": false,
|
"isExternal": false,
|
||||||
@ -1149,6 +1171,17 @@
|
|||||||
"path": "/ci/recipes/source-control-integration/gitlab",
|
"path": "/ci/recipes/source-control-integration/gitlab",
|
||||||
"tags": []
|
"tags": []
|
||||||
},
|
},
|
||||||
|
"/ci/recipes/source-control-integration/azure-devops": {
|
||||||
|
"id": "azure-devops",
|
||||||
|
"name": "Enable Azure DevOps PR Integration",
|
||||||
|
"description": "",
|
||||||
|
"mediaImage": "",
|
||||||
|
"file": "nx-cloud/set-up/azure-devops",
|
||||||
|
"itemList": [],
|
||||||
|
"isExternal": false,
|
||||||
|
"path": "/ci/recipes/source-control-integration/azure-devops",
|
||||||
|
"tags": []
|
||||||
|
},
|
||||||
"/ci/recipes/enterprise": {
|
"/ci/recipes/enterprise": {
|
||||||
"id": "enterprise",
|
"id": "enterprise",
|
||||||
"name": "Enterprise",
|
"name": "Enterprise",
|
||||||
|
|||||||
@ -6065,6 +6065,14 @@
|
|||||||
"isExternal": false,
|
"isExternal": false,
|
||||||
"children": [],
|
"children": [],
|
||||||
"disableCollapsible": false
|
"disableCollapsible": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Enable Azure DevOps PR Integration",
|
||||||
|
"path": "/ci/recipes/source-control-integration/azure-devops",
|
||||||
|
"id": "azure-devops",
|
||||||
|
"isExternal": false,
|
||||||
|
"children": [],
|
||||||
|
"disableCollapsible": false
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"disableCollapsible": false
|
"disableCollapsible": false
|
||||||
@ -6460,6 +6468,14 @@
|
|||||||
"isExternal": false,
|
"isExternal": false,
|
||||||
"children": [],
|
"children": [],
|
||||||
"disableCollapsible": false
|
"disableCollapsible": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Enable Azure DevOps PR Integration",
|
||||||
|
"path": "/ci/recipes/source-control-integration/azure-devops",
|
||||||
|
"id": "azure-devops",
|
||||||
|
"isExternal": false,
|
||||||
|
"children": [],
|
||||||
|
"disableCollapsible": false
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"disableCollapsible": false
|
"disableCollapsible": false
|
||||||
@ -6488,6 +6504,14 @@
|
|||||||
"children": [],
|
"children": [],
|
||||||
"disableCollapsible": false
|
"disableCollapsible": false
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"name": "Enable Azure DevOps PR Integration",
|
||||||
|
"path": "/ci/recipes/source-control-integration/azure-devops",
|
||||||
|
"id": "azure-devops",
|
||||||
|
"isExternal": false,
|
||||||
|
"children": [],
|
||||||
|
"disableCollapsible": false
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "Enterprise",
|
"name": "Enterprise",
|
||||||
"path": "/ci/recipes/enterprise",
|
"path": "/ci/recipes/enterprise",
|
||||||
|
|||||||
@ -1851,6 +1851,11 @@
|
|||||||
"name": "Enable GitLab MR Integration",
|
"name": "Enable GitLab MR Integration",
|
||||||
"id": "gitlab",
|
"id": "gitlab",
|
||||||
"file": "nx-cloud/set-up/gitlab"
|
"file": "nx-cloud/set-up/gitlab"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Enable Azure DevOps PR Integration",
|
||||||
|
"id": "azure-devops",
|
||||||
|
"file": "nx-cloud/set-up/azure-devops"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 54 KiB |
BIN
docs/nx-cloud/set-up/add-azure-devops-repository.webp
Normal file
|
After Width: | Height: | Size: 179 KiB |
|
Before Width: | Height: | Size: 150 KiB After Width: | Height: | Size: 142 KiB |
|
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 132 KiB |
41
docs/nx-cloud/set-up/azure-devops.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# Enable Azure DevOps PR Integration
|
||||||
|
|
||||||
|
## Get Started
|
||||||
|
|
||||||
|
The Nx Cloud + Azure Devops Integration lets you access the result of every run—with all its logs and build insights—straight from your PR.
|
||||||
|
|
||||||
|
## Connecting Your Workspace
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Once on the VCS Integrations setup page, select "Azure DevOps". You will be prompted to enter the name of your organization and project.
|
||||||
|
|
||||||
|
Identifying your organization and project can be done by looking at the URL of your project summary page.
|
||||||
|
|
||||||
|
```
|
||||||
|
https://dev.azure.com/[organization]/[project]
|
||||||
|
```
|
||||||
|
|
||||||
|
For example, the url `https://dev.azure.com/nrwl/my-monorepo-project` has an organization name of "nrwl", and a project name of "large-monorepo".
|
||||||
|
|
||||||
|
You will also need to provide the id of your Azure Git repository, this can either be the internal GUID identifier, if known, or you can use the name of the repository from the URL you use to access it.
|
||||||
|
|
||||||
|
For example, a URL of `https://dev.azure.com/nrwl/_git/large-monorepo` has the repository id of "large-monorepo".
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Configuring Authentication
|
||||||
|
|
||||||
|
#### Using a Personal Access Token
|
||||||
|
|
||||||
|
To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Once this token is created paste the value and then click "Connect".
|
||||||
|
|
||||||
|
This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved, and setup is complete.
|
||||||
|
|
||||||
|
### Advanced Configuration
|
||||||
|
|
||||||
|
If your company runs a self-hosted Azure DevOps installation, you may need to override the default URL that Nx Cloud uses to connect to the Azure Devops API. To do so, check the box labeled "Override Azure DevOps API URL" and enter the correct URL for your organization.
|
||||||
|
Before Width: | Height: | Size: 72 KiB |
BIN
docs/nx-cloud/set-up/find-gitlab-project-id.webp
Normal file
|
After Width: | Height: | Size: 30 KiB |
@ -31,7 +31,7 @@ Check the "_CI Platform Considerations_" section below and if there are no addit
|
|||||||
|
|
||||||
To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.
|
To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the "_CI Platform Considerations_" section below, and if there are no additional instructions for your platform of choice, setup is complete.
|
Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the "_CI Platform Considerations_" section below, and if there are no additional instructions for your platform of choice, setup is complete.
|
||||||
|
|
||||||
|
|||||||
@ -10,7 +10,7 @@ The Nx Cloud GitLab Integration lets you access the result of every run—with a
|
|||||||
|
|
||||||
Once on the VCS Integrations setup page, select "GitLab". You will be prompted to enter your project's ID.
|
Once on the VCS Integrations setup page, select "GitLab". You will be prompted to enter your project's ID.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
To locate the ID for your project, visit the home page of your repository on GitLab. The value can be found underneath the name of your project, and has a clickable button to copy to your clipboard.
|
To locate the ID for your project, visit the home page of your repository on GitLab. The value can be found underneath the name of your project, and has a clickable button to copy to your clipboard.
|
||||||
|
|
||||||
@ -22,7 +22,7 @@ To locate the ID for your project, visit the home page of your repository on Git
|
|||||||
|
|
||||||
To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.
|
To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect".
|
Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect".
|
||||||
|
|
||||||
|
|||||||
BIN
docs/nx-cloud/set-up/minimal-ado-access-token.webp
Normal file
|
After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 106 KiB |
BIN
docs/nx-cloud/set-up/minimal-github-access-token.webp
Normal file
|
After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 136 KiB |
BIN
docs/nx-cloud/set-up/minimal-gitlab-access-token.webp
Normal file
|
After Width: | Height: | Size: 54 KiB |
@ -10,7 +10,7 @@ To record a command with Nx Cloud:
|
|||||||
2. Prefix your command with `npx nx-cloud record --`, or the appropriate execute command of your package manager. The `--` is optional but makes it easier to read what portion of the command will be recorded. (example: npx nx-cloud record -- echo "hello world")
|
2. Prefix your command with `npx nx-cloud record --`, or the appropriate execute command of your package manager. The `--` is optional but makes it easier to read what portion of the command will be recorded. (example: npx nx-cloud record -- echo "hello world")
|
||||||
3. Run the command! Nx Cloud will record output and status codes, and generate a link for you to view your output on so you can easily view or share the result. Make sure you run this command from your workspace root or one of its subdirectories so Nx Cloud can properly locate configuration information.
|
3. Run the command! Nx Cloud will record output and status codes, and generate a link for you to view your output on so you can easily view or share the result. Make sure you run this command from your workspace root or one of its subdirectories so Nx Cloud can properly locate configuration information.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Locating Command Output in Nx Cloud
|
## Locating Command Output in Nx Cloud
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 21 KiB |
BIN
docs/nx-cloud/set-up/record-hello-world.webp
Normal file
|
After Width: | Height: | Size: 6.3 KiB |
|
Before Width: | Height: | Size: 145 KiB After Width: | Height: | Size: 178 KiB |
@ -37,7 +37,7 @@ For a more thorough explanation of how Nx Agents optimizes your CI pipeline, rea
|
|||||||
|
|
||||||
To enable task distribution with Nx Agents, there are two requirements:
|
To enable task distribution with Nx Agents, there are two requirements:
|
||||||
|
|
||||||
1. Enable version control system integration. The integrations currently available are [GitHub](/ci/recipes/source-control-integration/github), [GitLab](/ci/recipes/source-control-integration/gitlab) and [Bitbucket](/ci/recipes/source-control-integration/bitbucket-cloud). These integrations can be enabled from your [Nx Cloud dashboard](https://nx.app).
|
1. Enable version control system integration. The integrations currently available are [GitHub](/ci/recipes/source-control-integration/github), [GitLab](/ci/recipes/source-control-integration/gitlab), [Bitbucket](/ci/recipes/source-control-integration/bitbucket-cloud) and [Azure DevOps](/ci/recipes/source-control-integration/azure-devops). These integrations can be enabled from your [Nx Cloud dashboard](https://nx.app).
|
||||||
2. Add a single line to your CI pipeline configuration.
|
2. Add a single line to your CI pipeline configuration.
|
||||||
|
|
||||||
Add the `start-ci-run` command to your CI pipeline configuration after checking out the repository and before installing `node_modules`:
|
Add the `start-ci-run` command to your CI pipeline configuration after checking out the repository and before installing `node_modules`:
|
||||||
|
|||||||
@ -296,6 +296,7 @@
|
|||||||
- [Enable GitHub PR Integration](/ci/recipes/source-control-integration/github)
|
- [Enable GitHub PR Integration](/ci/recipes/source-control-integration/github)
|
||||||
- [Enable Bitbucket Cloud PR Integration](/ci/recipes/source-control-integration/bitbucket-cloud)
|
- [Enable Bitbucket Cloud PR Integration](/ci/recipes/source-control-integration/bitbucket-cloud)
|
||||||
- [Enable GitLab MR Integration](/ci/recipes/source-control-integration/gitlab)
|
- [Enable GitLab MR Integration](/ci/recipes/source-control-integration/gitlab)
|
||||||
|
- [Enable Azure DevOps PR Integration](/ci/recipes/source-control-integration/azure-devops)
|
||||||
- [Enterprise](/ci/recipes/enterprise)
|
- [Enterprise](/ci/recipes/enterprise)
|
||||||
- [On-Premise](/ci/recipes/enterprise/on-premise)
|
- [On-Premise](/ci/recipes/enterprise/on-premise)
|
||||||
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
- [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)
|
||||||
|
|||||||