Cyborg
Get early access
Integrations 48 pages
On this page

Integrations

Connect GitHub

Install the Cyborg GitHub App, connect a personal account, link a repository to a project, and map pull request states.

The GitHub integration syncs a repository’s issues with a Cyborg project and moves work items along as pull requests change state. It is a native Cyborg integration, connected once for the workspace.

Connect GitHub

Open Settings → Integrations, find GitHub, and click Connect (Manage once connected). The page is titled GitHub: “Connect and sync your GitHub work items with Cyborg.” It has these sections.

Organizations

“Connect your GitHub organization with Cyborg.”

  1. Click Connect organization. This opens GitHub to install the Cyborg GitHub App. Choose the account or organization and the repositories to allow.
  2. Back in Cyborg the account is listed under Organizations with its account type. Until an organization is connected the section reads “No organizations connected yet.”

If the button is disabled with the hint “The GitHub App is not configured yet”, the deployment has no GitHub App set up. On a self-hosted relay an administrator has to configure it first.

To remove an organization, click Disconnect on its row and confirm in the Disconnect GitHub dialog. This removes its repository syncs from the workspace. Workspace owners, admins and members can connect and disconnect.

Personal account

“Connect your personal GitHub account with Cyborg.” Click Connect account to sign in with GitHub as yourself. Your login is then listed with Connected.

Under Project issue sync (“Sync issues from GitHub to your Cyborg project.”):

  1. Click Link repository. It is disabled until an organization is connected.
  2. In the dialog Link GitHub Repository to a Plane Project, choose the project (Choose Project…) and the Account / Organization, then the GitHub Repository (Choose Repository…).
  3. Under Configure Issue Sync State, choose which workflow state an Issue Open and an Issue Closed map to (Select State).
  4. Under Select issue sync direction, choose one of:
    • Bidirectional: sync issues and comments both ways between GitHub and the project.
    • Unidirectional: sync issues and comments from GitHub to the project only.
  5. Click Start sync.

The linked repository appears in the list, with an edit button (to change the direction and states) and a remove button. Removing asks you to confirm Remove repository link.

Pull request state mapping

Under Pull request state mapping (“Map GitHub pull request states to your Cyborg project.”), choose a project, then choose the workflow state each pull request state moves its linked work items to:

  • Draft Open
  • Open
  • Review Requested
  • Merged
  • Closed
  • Ready for Merge (marked “not yet active”: you can save a mapping, but nothing sets this state yet)

Use Set state on a row to choose a state, and the clear button to remove a mapping. The switch Prevent issues from moving to an earlier state due to PR updates stops a later pull request event from moving a work item backwards.