CodeLantern Docs
Getting Started

Connect Your Repository

Connect your organization to GitHub and register the repository you'll work in, the setup CodeLantern's skills depend on.

This is the first step, and you do all of it in the CodeLantern portal before you install the plugin.

Here's why the order matters. CodeLantern's skills act on your issues and pull requests on your behalf. Before a skill runs, CodeLantern checks two things: that you're authorized to work in the repository, and that the repository has a mapping telling CodeLantern where its work lives: which provider manages its issues (its project management, or PM) and where its code lives (its source control, or SCM). Both are configured in the portal, so you set them up first. The plugin and its skills rely on this being in place.

A repository connected in the CodeLantern portal, showing its project-management mapping and an Active status

What you'll need

  • A CodeLantern account and organization. If your team is just getting started, contact CodeLantern to get set up. That covers signing in and creating your organization.
  • Permission to connect your GitHub organization, or an admin on your team who can do the connection step for you.

1. Connect your GitHub organization

Open Integrations and connect GitHub through the CodeLantern GitHub App. This authorizes CodeLantern to read and write the issues, pull requests, and code in the repositories you choose. GitHub can act as both your project manager and your source control.

If your team tracks its work in Linear, you can also connect Linear here (through OAuth). Linear is project-management only; source control is always GitHub. Connect it only if you plan to use it.

2. Add your repository and set its mapping

Open Repositories and choose Add Repository:

  1. Select the repository you want to work in, from the list CodeLantern can see through the GitHub App.
  2. Choose its PM provider: GitHub Projects (issues live on GitHub) or Linear (issues live in Linear). Source control stays on GitHub either way.
  3. Choose the project: for GitHub Projects, pick the project from the list CodeLantern loads for you; for Linear, select the team.
  4. Choose Add.
The Add Repository form, with a repository selected, its PM provider set to GitHub Projects, and a project identifier entered

The repository now shows as Active with its mapping. This mapping is what lets a skill read the right issue and open the pull request in the right place. It's also the check the skills run before they act, which is why you configure it before installing the plugin.

Next step

With your organization connected and your repository registered, install the plugin.

On this page