Admin

Setup & Repository Access

How GitHub permissions map to CarbonRunner access

Overview#

CarbonRunner uses GitHub for authentication, and inherits your GitHub organization's structure. All members of your GitHub organization can log in using their GitHub accounts to access the CarbonRunner dashboard.

1. Sign up / Sign in to CarbonRunner#

Once you're logged in, our setup wizard guides you through connecting your GitHub account and the following steps below.

2. Connect GitHub via our wizard#

This is the link between your GitHub repositories and CarbonRunner.

Once logged in, our setup wizard will guide you through installing the CarbonRunner GitHub App within your chosen organization or profile.

3. Choose repository access#

During installation, you can decide whether to give CarbonRunner access to all of your repositories or just specific ones. This ensures you're always in control of where CarbonRunner runs.

All repositories#

If you choose to give CarbonRunner access to all repositories, every project under your GitHub account or organisation is automatically connected. This makes setup seamless — any new repositories you create in the future will also be included without extra steps. It's the easiest option if you want full coverage and don't want to manage permissions repo by repo.

Only select repositories#

If you prefer more control, you can choose specific repositories for CarbonRunner to access. This lets you test CarbonRunner on certain projects before rolling it out more widely, or limit usage to only the workflows that matter most to you. You can add or remove repositories from CarbonRunner at any time directly in your GitHub settings.

Don't worry — this isn't scary.

The CarbonRunner GitHub App is read-only when first connected. Nothing in your repositories will change until you explicitly update your workflow file with "runs-on". This makes it a great way to start measuring your current GitHub Action emissions without altering how your jobs run today.

Conclusion#

Connecting CarbonRunner to GitHub is quick, simple, and read-only until you're ready to take the next step.

You stay in full control — CarbonRunner lets you measure your GitHub Action emissions first, and only when you're comfortable do you switch your workflows to run with us. We've done this by design to make adoption stress-free, leaving the timing and action firmly in your hands.

The Greenest Way to Run GitHub Actions.