Skip to content
Getting Started

Getting Started

Welcome! Follow the steps below to use the BuildJet for GitHub Actions runners.

Install BuildJet

You can install BuildJet onto your repository here. It's a GitHub OAuth application that will allow us to listen to your GitHub Actions runs and give you access to the BuildJet hardware.

If you don't have admin rights in the repository, please contact your repository owner and ask them to install BuildJet for GitHub Actions. Simply send them the link above.

Add BuildJet to your workflow.yml

In order for BuildJet for GitHub Actions to be used by your workflow job, we need to specify a runner tag in the jobs.[job-name].runs-on property.

We recommend starting with the 4 vCPU runner, as this has the same cost as the GitHub runner and is a good baseline for comparison. For a complete list of runners, click here.

name: Test Suite
on: push
jobs:
  test:
    runs-on: buildjet-4vcpu-ubuntu-2004
    name: Test
    steps:
      - uses: actions/[email protected]

Next steps

Congratulations! That is all you need to do to get up and running with BuildJet for GitHub Actions. Now you can try to out different BuildJet hardware configurations and see how much they improve the job.

Some jobs don't need an 8vCPU machine, but a 2vCPU would be enough.You should play around and see what works best for your setup.