diff --git a/docs/generated/manifests/ci.json b/docs/generated/manifests/ci.json index d515786c10..534fb07167 100644 --- a/docs/generated/manifests/ci.json +++ b/docs/generated/manifests/ci.json @@ -569,6 +569,17 @@ "isExternal": false, "path": "/ci/recipes/source-control-integration/gitlab", "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, @@ -1110,6 +1121,17 @@ "isExternal": false, "path": "/ci/recipes/source-control-integration/gitlab", "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, @@ -1149,6 +1171,17 @@ "path": "/ci/recipes/source-control-integration/gitlab", "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": { "id": "enterprise", "name": "Enterprise", diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index c7ac5afffe..cf319e766b 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -6065,6 +6065,14 @@ "isExternal": false, "children": [], "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 @@ -6460,6 +6468,14 @@ "isExternal": false, "children": [], "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 @@ -6488,6 +6504,14 @@ "children": [], "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", "path": "/ci/recipes/enterprise", diff --git a/docs/map.json b/docs/map.json index ae6d1fec5d..48090b5760 100644 --- a/docs/map.json +++ b/docs/map.json @@ -1851,6 +1851,11 @@ "name": "Enable GitLab MR Integration", "id": "gitlab", "file": "nx-cloud/set-up/gitlab" + }, + { + "name": "Enable Azure DevOps PR Integration", + "id": "azure-devops", + "file": "nx-cloud/set-up/azure-devops" } ] }, diff --git a/docs/nx-cloud/set-up/access-vcs-setup.webp b/docs/nx-cloud/set-up/access-vcs-setup.webp index c56303912a..f8883643f1 100644 Binary files a/docs/nx-cloud/set-up/access-vcs-setup.webp and b/docs/nx-cloud/set-up/access-vcs-setup.webp differ diff --git a/docs/nx-cloud/set-up/add-azure-devops-repository.webp b/docs/nx-cloud/set-up/add-azure-devops-repository.webp new file mode 100644 index 0000000000..c82b8bdf83 Binary files /dev/null and b/docs/nx-cloud/set-up/add-azure-devops-repository.webp differ diff --git a/docs/nx-cloud/set-up/add-bitbucket-cloud-repository.webp b/docs/nx-cloud/set-up/add-bitbucket-cloud-repository.webp index 7ed314c54a..3cb2d70c64 100644 Binary files a/docs/nx-cloud/set-up/add-bitbucket-cloud-repository.webp and b/docs/nx-cloud/set-up/add-bitbucket-cloud-repository.webp differ diff --git a/docs/nx-cloud/set-up/add-gitlab-repository.webp b/docs/nx-cloud/set-up/add-gitlab-repository.webp index 3e25caff5c..fd3e0a061f 100644 Binary files a/docs/nx-cloud/set-up/add-gitlab-repository.webp and b/docs/nx-cloud/set-up/add-gitlab-repository.webp differ diff --git a/docs/nx-cloud/set-up/azure-devops.md b/docs/nx-cloud/set-up/azure-devops.md new file mode 100644 index 0000000000..4bbcfaf285 --- /dev/null +++ b/docs/nx-cloud/set-up/azure-devops.md @@ -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 + +![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.webp) + +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". + +![Add Azure DevOps Repository](/nx-cloud/set-up/add-azure-devops-repository.webp) + +### 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. + +![Work Items - Read, Code - Read, Build - Read & execute, Release - Read, write, & execute](/nx-cloud/set-up/minimal-ado-access-token.webp 'Minimum Azure DevOps Personal Access Token Permissions') + +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. diff --git a/docs/nx-cloud/set-up/find-gitlab-project-id.png b/docs/nx-cloud/set-up/find-gitlab-project-id.png deleted file mode 100644 index ec9f77bc35..0000000000 Binary files a/docs/nx-cloud/set-up/find-gitlab-project-id.png and /dev/null differ diff --git a/docs/nx-cloud/set-up/find-gitlab-project-id.webp b/docs/nx-cloud/set-up/find-gitlab-project-id.webp new file mode 100644 index 0000000000..e0092b4904 Binary files /dev/null and b/docs/nx-cloud/set-up/find-gitlab-project-id.webp differ diff --git a/docs/nx-cloud/set-up/github.md b/docs/nx-cloud/set-up/github.md index 83439292cd..eb152ff0ed 100644 --- a/docs/nx-cloud/set-up/github.md +++ b/docs/nx-cloud/set-up/github.md @@ -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. -![Minimum GitHub Personal Access Token Permissions](/nx-cloud/set-up/minimal-github-access-token.png) +![Minimum GitHub Personal Access Token Permissions](/nx-cloud/set-up/minimal-github-access-token.webp) 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. diff --git a/docs/nx-cloud/set-up/gitlab.md b/docs/nx-cloud/set-up/gitlab.md index 552343eb68..3659d4052a 100644 --- a/docs/nx-cloud/set-up/gitlab.md +++ b/docs/nx-cloud/set-up/gitlab.md @@ -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. -![Locate Gitlab Project ID](/nx-cloud/set-up/find-gitlab-project-id.png) +![Locate Gitlab Project ID](/nx-cloud/set-up/find-gitlab-project-id.webp) 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. -![Minimum GitLab Personal Access Token Permissions](/nx-cloud/set-up/minimal-gitlab-access-token.png) +![Minimum GitLab Personal Access Token Permissions](/nx-cloud/set-up/minimal-gitlab-access-token.webp) Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect". diff --git a/docs/nx-cloud/set-up/minimal-ado-access-token.webp b/docs/nx-cloud/set-up/minimal-ado-access-token.webp new file mode 100644 index 0000000000..79c8bb5eb5 Binary files /dev/null and b/docs/nx-cloud/set-up/minimal-ado-access-token.webp differ diff --git a/docs/nx-cloud/set-up/minimal-github-access-token.png b/docs/nx-cloud/set-up/minimal-github-access-token.png deleted file mode 100644 index f098ca923e..0000000000 Binary files a/docs/nx-cloud/set-up/minimal-github-access-token.png and /dev/null differ diff --git a/docs/nx-cloud/set-up/minimal-github-access-token.webp b/docs/nx-cloud/set-up/minimal-github-access-token.webp new file mode 100644 index 0000000000..d27758cf0c Binary files /dev/null and b/docs/nx-cloud/set-up/minimal-github-access-token.webp differ diff --git a/docs/nx-cloud/set-up/minimal-gitlab-access-token.png b/docs/nx-cloud/set-up/minimal-gitlab-access-token.png deleted file mode 100644 index facde7a154..0000000000 Binary files a/docs/nx-cloud/set-up/minimal-gitlab-access-token.png and /dev/null differ diff --git a/docs/nx-cloud/set-up/minimal-gitlab-access-token.webp b/docs/nx-cloud/set-up/minimal-gitlab-access-token.webp new file mode 100644 index 0000000000..2a57fead32 Binary files /dev/null and b/docs/nx-cloud/set-up/minimal-gitlab-access-token.webp differ diff --git a/docs/nx-cloud/set-up/record-commands.md b/docs/nx-cloud/set-up/record-commands.md index 402be4667b..c746151b14 100644 --- a/docs/nx-cloud/set-up/record-commands.md +++ b/docs/nx-cloud/set-up/record-commands.md @@ -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") 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. -![npx nx-cloud record -- echo "hello world"](/nx-cloud/set-up/record-hello-world.png) +![npx nx-cloud record -- echo "hello world"](/nx-cloud/set-up/record-hello-world.webp) ## Locating Command Output in Nx Cloud diff --git a/docs/nx-cloud/set-up/record-hello-world.png b/docs/nx-cloud/set-up/record-hello-world.png deleted file mode 100644 index d7c715c9c8..0000000000 Binary files a/docs/nx-cloud/set-up/record-hello-world.png and /dev/null differ diff --git a/docs/nx-cloud/set-up/record-hello-world.webp b/docs/nx-cloud/set-up/record-hello-world.webp new file mode 100644 index 0000000000..aabfb775aa Binary files /dev/null and b/docs/nx-cloud/set-up/record-hello-world.webp differ diff --git a/docs/nx-cloud/set-up/use-github-app-auth.webp b/docs/nx-cloud/set-up/use-github-app-auth.webp index 0fa96f9252..5f56920a46 100644 Binary files a/docs/nx-cloud/set-up/use-github-app-auth.webp and b/docs/nx-cloud/set-up/use-github-app-auth.webp differ diff --git a/docs/shared/features/distribute-task-execution.md b/docs/shared/features/distribute-task-execution.md index 0c68c35dd4..092582c078 100644 --- a/docs/shared/features/distribute-task-execution.md +++ b/docs/shared/features/distribute-task-execution.md @@ -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: -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. Add the `start-ci-run` command to your CI pipeline configuration after checking out the repository and before installing `node_modules`: diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index 343c481922..47eb1068f4 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -296,6 +296,7 @@ - [Enable GitHub PR Integration](/ci/recipes/source-control-integration/github) - [Enable Bitbucket Cloud PR Integration](/ci/recipes/source-control-integration/bitbucket-cloud) - [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) - [On-Premise](/ci/recipes/enterprise/on-premise) - [Authenticate with a Single Admin](/ci/recipes/enterprise/on-premise/auth-single-admin)