Connect a GitHub repo

Your project files can be stored in a repository on GitHub. Connect that repository so you can access, edit, and publish those files in Reunite. To connect a GitHub repository, you must first install the Redocly app in GitHub, then enter the connection details in Reunite.

You can connect a repository in two contexts:

• When you create a project: in the Create project modal, select Connect existing repository. Reunite builds the new project from the content of your repository. See Create a project from an existing repository.
• For an existing project: on the Settings > Git hosting page, as described in the steps on this page. This replaces the current files of the project with the files from the repository.

The Redocly app installation is required in both contexts.

Before you enter the GitHub repository connection details in Reunite, you must install the Redocly GitHub App on your organization in GitHub.

To install the Redocly GitHub App on your organization in GitHub:

1. Navigate to Install Redocly, and select the organization on GitHub.
2. Enter your GitHub password to confirm access.
3. Grant the Redocly GitHub App access to your project's repository.

See Installing a GitHub App from a third party in the GitHub documentation for more information.

After you install the Redocly GitHub App on your organization in GitHub, enter the repository connection details in Reunite. This completes the process of adding a GitHub repository to your project.

To enter the connection details:

1. From your project, select Settings > Git hosting > GitHub > Next.

2. Authorize your Redocly organization to verify your GitHub identity.

3. Select your GitHub Organization > Repository > Branch.

4. (Optional) Select the Monorepo folder. Use it if your project files are part of a monorepo and you want to include only a specific folder from the repository.

   Monorepo folder

   If 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 is allowed to add to connected folder only

5. Select Next > Connect.

   Warning

   This step deletes the files currently in the Redocly project and replaces them with the files in GitHub.

• Include remote content - Integrate content from external GitHub repositories into your Reunite projects for unified documentation management
• Use the Editor - Explore Reunite's collaborative editing environment for creating and managing content with GitHub integration
• Manage projects - Access feedback, deployment details, and project settings for comprehensive GitHub-connected project management
• Configuration reference - Complete redocly.yaml configuration options for GitHub integration, deployment, and project customization