EvergreenDocs

Connect your code

Install the Evergreen GitHub App on the accounts that hold your repositories, then link your own GitHub account so the agent's work carries your name.

  • Owner · Admin
  • 5 minutes

Before you begin

  • You’re an Owner or Admin of your Evergreen workspace.
  • You can install apps on the GitHub organization, or a GitHub organization owner is ready to approve the request.

Note

One GitHub installation can serve several of your workspaces. If the app is already on a GitHub account you own, Install lists it under Already installed on GitHub, and Add to your workspace links it here too. Your other workspaces keep it.

Install the GitHub App

  1. Open Integrations

    In Evergreen, open the account menu and go to Workspace settings › Integrations. Find GitHub and choose Install.

  2. Install on your GitHub accounts

    Choose Install on GitHub, and GitHub opens its install page. Pick the organization, choose All repositories or Only select repositories, then choose Install. GitHub sends you back to Evergreen.

    Tip

    Start with the few repositories your first sessions will touch. You can add more later without installing again.

  3. Pick repositories

    Evergreen shows the repositories each account lets it reach. To change them, choose Choose on GitHub, and Evergreen picks up the change within a minute.

  4. Choose who can use it

    Choose Everyone, Selected audiences, or Only me, then choose Turn on for and your workspace’s name. You can change this any time. Choose Done to close.

Each person does this once, Admins included. Go to Settings › Integrations, find GitHub, and choose Connect. The agent then commits as you, with Evergreen’s app pushing the work, so your pull requests reach your reviewers the way your own would. If someone skips this step, their sessions still run, and Evergreen’s app acts for them.

Note

New members see this step in the welcome dialog the first time they sign in. If they choose Not now, they can connect later from Settings.

Check that it works

Choose New in the sidebar and start a session on one of the repositories you picked. A small, real task shows the whole loop:

In acme/web, add a GET /healthz endpoint that returns 200 with {"ok": true}, and a test for it.

New sessions start in Auto unless you’ve set another default, so the agent gets straight to work and opens a pull request on GitHub. To read and approve a plan first, choose More under the brief box and pick Plan in How it runs before you start.

Use GitLab instead

GitLab has no app to install, so Install asks which GitLab you use, gitlab.com or your own instance, and then a group you own to install Evergreen on. On your own instance, first register an application in GitLab with these scopes, and the redirect URI the step shows:

api write_repository
https://gitlab.example.com

Troubleshooting

What you see What to do
A repository is missing from the picker The installation doesn’t include it. Open Manage › Pick repositories › Manage on GitHub and add it.
GitHub asks an owner to approve Only a GitHub organization owner can approve an app. Ask one to approve the request, then choose Install again.
There’s no Install button Only Owners and Admins install integrations. Ask one of them, or choose Request.

Last updated

Esc