https://github.com/austenstone/is-larger-worth
Are larger runners worth it? Test for yourself.
https://github.com/austenstone/is-larger-worth
benchmark github larger-runner
Last synced: 12 months ago
JSON representation
Are larger runners worth it? Test for yourself.
- Host: GitHub
- URL: https://github.com/austenstone/is-larger-worth
- Owner: austenstone
- Created: 2023-08-08T20:43:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-27T17:57:47.000Z (over 2 years ago)
- Last Synced: 2025-04-06T12:17:06.523Z (about 1 year ago)
- Topics: benchmark, github, larger-runner
- Homepage:
- Size: 60.5 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Are larger runners worth the cost increase?
GitHub's [Larger runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-larger-runners) have more CPU, RAM, and disk space. They also cost more. Are they worth it?
This repository contains a simple benchmark that runs on the default and larger runners.
## How to run the benchmark
### Generating the runners
You could create the runners manually but I made a workflow that does this for you!
There is a workflow called [`runners-create.yml`](.github/workflows/runners-create.yml) that will create a runner group for you called `larger-runners` and then add all the different runner sizes to that group: `4-core`, `8-core`, `16-core`, `32-core`, `64-core`.
You MUST add a new secret called `PAT` that is a GitHub Personal Access token with the permissions to create these runners/group.
### Running the test
The basic test is called `benchmark-matrix.yml` and it calls `benchmark.yml` for each of the different runner sizes. Once you've generated the runners from the previous step you can execute this workflow manually using workflow dispatch.
### CodeQL
There is also a prewritten workflow for testing larger runners with CodeQL [`codeql-analysis-larger.yml`](.github/workflows/codeql-analysis-larger.yml). You will need to modify your `codeql.yml` workflow file slightly.
Replace your workflow event with the `workflow_call` event so that it can be called as a reusable workflow. Define the `runs-on` input variable so we can pass it in.
```yml
on:
workflow_call:
inputs:
runs-on:
default: 'ubuntu-latest'
required: false
type: string
```
Then replace the `runs-on` label in the workflow file with the new variable we are passing in.
```yml
runs-on: ${{ inputs.runs-on }}
```
That's it! Now you can trigger codeql scans from the workflow `codeql-matrix.yml` and it will simultaneously run the codeql workflow with all different larger runner types.