Get Started with CarbonRunner in Minutes

Measure first. Optimize effortlessly. 🌍🚀

With CarbonRunner, sustainability starts with insight. First, measure the carbon impact of your existing CI/CD workflows without changing a thing—just install the app and see real-time emissions data from your current setup. Once you have a clear picture, optimizing is effortless. A simple update to your runs-on line seamlessly shifts your workflows to our carbon-aware infrastructure, automatically routing jobs to the lowest-carbon regions. No complex setup, no performance trade-offs—just smarter, greener CI/CD. 🌍🚀

Step 1: Measure Your Existing CI/CD Workflows (optional)

With CarbonRunner, you can start by measuring the carbon impact of your existing CI/CD workflows—no changes needed. Simply install the CarbonRunner app and add it to your repository, without modifying your runs-on line. This lets you see real-time emissions data from your current setup, giving you a clear picture of your environmental impact before making any adjustments.

• Install the CarbonRunner App - Select specific repositories or grant access to all repositories.
• Authorize the App - Review the requested permissions. Click “Authorize” to allow CarbonRunner to access your repositories.
• View Your Carbon Insights - Log in to the CarbonRunner Dashboard to explore your CI/CD emissions data. See detailed stats, graphs, and usage minutes, giving you a clear picture of your impact and optimizations over time. 🌍📊

Step 2: Swap to CarbonRunner for Greener Builds

When you're ready to optimize, simply update your runs-on line to use CarbonRunner. With this one change, your workflows will automatically run on our carbon-aware infrastructure, dynamically selecting the lowest-carbon regions in real time. This means your CI/CD processes will have a significantly lower environmental impact—without sacrificing speed or reliability. It’s a simple switch with a big sustainability payoff.

• Install the CarbonRunner App - Select specific repositories or grant access to all repositories.
• Authorize the App - Review the requested permissions. Click “Authorize” to allow CarbonRunner to access your repositories.
• Create a Pull Request to Enable CarbonRunner - Change the `runs-on` label to `carbonrunner-4vcpu-ubuntu-latest`. Once you're happy with the results, merge the PR to start running your CI/CD jobs on CarbonRunner's carbon-aware infrastructure. 🌍🚀

1
2jobs:
3    deploy: 
4-       runs-on: ubuntu-latest
5+       runs-on: carbonrunner-4vcpu-ubuntu-latest
6

• View Your Carbon Insights - Log in to the CarbonRunner Dashboard to explore your CI/CD emissions data. See detailed stats, graphs, and usage minutes, giving you a clear picture of your impact and optimizations over time. 🌍📊

New to Github Actions?

New to Github Actions? You can follow the official Github Tutorial here or if you're more of a visual learner I found this tutorial about CI/CD Tutorial using GitHub Actions from Tom Shaw.