Quickstart

This guide describes how to integrate your GitHub Action workflows with Ubicloud runners. For this, you’re going to sign up to Ubicloud, use our GitHub App to connect to your GitHub repo, and change one line in your GitHub workflow file. This will provide the following benefits:

  • Reduce your GitHub Actions bill by 10x
  • Native x64 and arm64 Linux runners
  • Full compatibility with GitHub Actions
  • Open source, if you choose to manage Ubicloud VMs yourself

Sign up and sign in

The first time you use Ubicloud, you'll need to create a new account: https://console.ubicloud.com/create-account. Once you do that and sign in, you’ll be directed to Ubicloud’s home page.

Enter billing details

Ubicloud requires an active, valid credit card on file before you can create resources. This is primarily a means to prevent abuse and to ensure that we can collect payment at the end of the month.

Ubicloud also provides a billing credit of $1/month for an account. This means you'll get 1,250 free minutes of GitHub runner credits each month.

From the navigation menu on the left, choose Billing. Then, enter your credit card information.

Integrate with GitHub

On the navigation menu, choose GitHub Runners. Then, click on Connect New Account on the right. This will take you to GitHub.

GitHub will ask you to install and authorize the Ubicloud Managed Runners app. Once you do this, you will be redirected to the Ubicloud cloud dashboard. Here, you should now see your GitHub repositories.

Change your workflow.yml file

To use Ubicloud for GitHub Actions, you need to edit your .github/workflows file. In particular, you need to change the ubuntu-latest runner tag to ubicloud.

When you merge this change, GitHub Actions will start using Ubicloud runners. If your workflow file has builds configured on merging a change, you see your build start in your project's Actions tab. If not, you can manually start a build to see the change take effect.

By default, ubicloud starts a VM with the same vCPU and memory configuration as GitHub runners. Given Ubicloud's 10x price advantage, you might want to pick a more powerful VM and see if your pipelines move faster. You can find the full list of runners, their prices, and performance benchmarks here.

Summary: In this guide, you created a Ubicloud account and integrated that account with your GitHub Account. You then changed a single line in your workflow file to use Ubicloud runners.

This resulted in 10x lower prices and faster CI/CD, with Ubicloud's source code openly available under the AGPL license.