Connect a Bitbucket Cloud repo
If your project files are stored in a remote repository on Bitbucket Cloud, you can connect that repository, so you can access, edit, and publish those files in Reunite.
To connect a Bitbucket Cloud repository, you must first create a new access token in Bitbucket Cloud, then enter the connection details in Reunite.
Create a new repository access token in Bitbucket Cloud
Before entering the connection details in Reunite, you need to create and copy a new repository access token for your account in Bitbucket Cloud. Redocly uses this access token to establish a connection to your repository. The access token you use needs to have repository:write
, pullrequest:write
and webhook
scopes.
See the Bitbucket Cloud documentation for creating the following access token types with appropriate permissions and scopes:
Enter the connection details in Redocly
From your project, select Settings > Git hosting.
From the list of Git providers, select Bitbucket Cloud.
Enter a Credential name for the new Bitbucket Cloud credential.
Enter the Workspace name of the Bitbucket Cloud Workspace and select Next.
Enter the Access token you saved from the Create a new repository access token in Bitbucket Cloud step and select Next.
Select the Namespace > Project > Branch.
(Optional) Select the Monorepo folder, if your project files are part of a monorepo, and you want to include only a specific folder from the repository.
Monorepo folderIf you select to only include a specific folder from a monorepo:
- Only files listed in file tree are cloned, no other files are included
- Project builds are started only when branch contains changes to connected folder
- Remote content can only be added to the connected folder.
Select Next > Connect.
WarningThis step deletes the files currently in the Redocly project and replaces them with the files in Bitbucket Cloud.
Related how-tos
- Follow steps to include remote content from a different repository in your project.
- Check out all the ways you can use the Editor in Reunite to create content.
Resources
- Learn more about where you can view feedback and deployment details for projects in Reunite.
- View the different options for configuring your project in the
redocly.yaml
file in the Configuration reference documentation.