Add remote files from Azure DevOps

If your content is stored in a repository on Azure DevOps Services, you can connect that repository, so you can access and publish those files in Redocly.

To connect an Azure DevOps repo:

1. Create new personal access token (PAT) token in Azure DevOps.
2. Create a new branch in Redocly.
3. Enter the connection details in Redocly.
4. Merge open pull request in Redocly.

Create a new access token in Azure DevOps

Permissions

Before creating Personal Access Token (PAT) for your user, make sure that they have a correct access right to the desired Azure projects. Redocly recommends putting your user in the Project Administrators security group for your Azure DevOps project, since this security group has all the needed permissions by default.

(For example, only the Project Administrators security group has the View subscriptions and the Edit subscriptions permissions enabled by default. Redocly needs these permissions to be able to setup service hooks (webhooks) for the Azure project.)

Alternatively, you can put your user in the Project Contributors security group and add the View subscriptions and the Edit subscriptions permissions manually. See Manage permissions with command line tool or Security REST API in Microsoft Azure DevOps documentation for detailed instructions.

PAT scopes

Before you enter the connection details in Redocly, you need to create and copy a new PAT for your account in Azure DevOps. Redocly uses this access token to establish a connection to your repository.

See Create a PAT in Microsoft Azure DevOps documentation for detailed instructions.

You must select an Organization for this PAT. Do not select All accessible organizations.

Also, the PAT you use must have API scopes defined. You can choose the Full access option, or select Custom defined and enable the following specific scopes:

• Code: Read, write, & manage and Status

The following screenshot from Azure DevOps shows the required custom defined scopes:

Reunite requires:

• Code -> Read (vso.code) scope for all read operations in Reunite (list of repositories, branches, files, file contents, diffs, list of PRs, etc.).
• Code -> Write (vso.code_write) scope for all write operations in Reunite (create/update Pull Requests, remove branches, synchronize remote content).
• Code -> Manage (vso.code_manage) scope for creating new code repositories from Reunite app.
• Code -> Status (vso.code_status) scope for setting commit and PR statuses (Lint status, Build status, Link checker status, Visual review).

See Scopes in Microsoft Azure DevOps documentation for detailed information about scopes permissions.

Create a new branch in Redocly

Before you make any changes to your project, you should create a new branch. This new branch is a place where you can make changes without affecting the published site until you are ready. After you have iterated on your changes based on reviews by your team and the updates have been approved, you can merge your changes into the published site.

To create a new branch:

1. Go to the project editor.

2. Click the name of the current branch.

   

3. Enter the name for your new branch and select Create Branch.

Enter the connection details in Redocly

1. In the file tree, select the folder (or click on the empty space to select the root directory) where you want to add the remote content folder.
2. Select + > New remote folder > Add Git repository.
3. Enter a name for the new remote content folder and press Enter or Return key.
4. Select Azure DevOps Services.
5. Enter a Credential name that identifies this Azure DevOps Services connection.
6. Enter the Access token you saved from the Create a new access token in Azure DevOps step.
7. Enter the Organization name where you created the access token and select Next.
8. Select your Organization > Repository > Branch.
9. (Optional) Select the Folder, if you want to include only a specific folder from the repository.
10. Select the Auto-sync or Auto-merge toggles to turn off either option.
11. Select Add remote. This action opens a pull request in Redocly automatically. After refreshing your browser, you should see a View Pull Request button next to your new branch name.

Merge the open pull request in Redocly

After you enter the connection details in Redocly, a pull request to merge your updates with the default branch opens.

1. Refresh your browser to see a View Pull Request button next to your new branch name.
2. Select View Pull Request.
3. Review your updates in the Review tab.
4. After the tests have run and your pull request has been approved, click the Merge button to merge your updates with the default branch.

Related how-tos

• Connect a Git provider
• Use the Editor