Skip to main content

GitHub

GitHub supplies the repository, issues, and pull requests Factory works with.

Connect the repository​

Use Get started to create and start the server, then select the codebase agents should change. During onboarding you need to install the GitHub App to configure access to your repositories. Link the project Factory should work in.

If a repository is missing from the picker, select Manage GitHub connection. In GitHub, update the installation to include the intended repository, then return to Factory and reopen the picker. Request an organization administrator's help if you can't change the installation.

Access to all repositories is optional. Grant access to the repositories you intend to use.

Select your issue intake​

  1. Open Settings → Work Intake.
  2. Under GitHub issues, enable Sync GitHub issues.
  3. Select the repositories you want to follow.
  4. Wait for Intake sources updated, then return to Work.

Each teammate manages their own intake selection after the repository is connected. Factory brings pull requests from your linked repository into Review. See Review items.

If issues don't appear in Factory, read Troubleshooting.

Use your own GitHub App​

Most users can use the Platform-backed connection. For a server with a separate GitHub App, the generated entry recognizes a complete App configuration through its GITHUB_APP_* variables.

Install the App on the target repositories and configure its callback and webhook settings to reach your server. The webhook signing secret must remain stable across restarts. See the environment variables and GitHub's App documentation before switching an existing server.