GitHub Integration

Guidebook Cloud integrates with GitHub to automatically build and deploy your documentation when you push changes.

Installing the GitHub App

Before you can import repositories, you need to install the Guidebook Cloud GitHub App.

Installation Steps

  1. Go to Settings > GitHub Integration
  2. Click Install GitHub App
  3. Select the GitHub account or organization
  4. Choose repository access:
    • All repositories - Grants access to all current and future repositories
    • Only select repositories - Grants access to specific repositories only
  5. Click Install

Adding More Accounts

You can connect multiple GitHub accounts or organizations:

  1. Go to Settings > GitHub Integration
  2. Click Add Another Account
  3. Follow the installation steps

Connected Accounts

The GitHub Integration page shows all connected GitHub accounts with:

  • Account name and type (User or Organization)
  • Connection date

Removing a Connection

To remove a GitHub account:

  1. Go to Settings > GitHub Integration
  2. Click Remove next to the account
  3. Confirm the removal

Removing a connection will disconnect all repositories imported from that account.

Connecting a Repository

After installing the GitHub App, you can connect repositories:

New Repository Import

  1. Go to Repositories > New Repository
  2. Filter or search for your repository
  3. Click Import
  4. Configure the documentation path
  5. Click Import

Connecting an Existing Repository

If you have a repository without a GitHub connection:

  1. Go to Repository Settings
  2. Under GitHub Connection, click Connect
  3. Select a GitHub repository from the list
  4. Configure the documentation path
  5. Click Connect Repository

Auto Deploy Configuration

When connected to GitHub, you can configure automatic deployments.

Auto Deploy Toggle

  • Enabled - Automatically build when changes are pushed
  • Disabled - Manual builds only

Deploy Branches

Choose which branches trigger automatic deployments:

  • Default branch only - Only the main/master branch (e.g., main)
  • All branches - Every branch triggers a build
  • Custom patterns - Specify branch patterns (e.g., main, release/*, feature/**)

Webhook Events

Guidebook Cloud listens for the following GitHub events:

  • Push - Triggers a build for the pushed branch
  • Delete - Removes the branch from Guidebook Cloud

Disconnecting a Repository

To disconnect a repository from GitHub:

  1. Go to Repository Settings
  2. Under GitHub Connection, click Disconnect
  3. Confirm the disconnection

After disconnecting:

  • Automatic deployments are disabled
  • Existing builds and branches remain
  • You can reconnect to the same or different GitHub repository