k6 in GitHub Actions
Set up k6 tests to run automatically as part of your GitHub Actions workflows.
k6 in GitHub Actions is a free Load Testing & Performance Benchmarking (JMeter & k6) lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Load Testing & Performance Benchmarking (JMeter & k6) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Automating Performance Testing
Welcome to integrating performance testing with CI/CD! Continuous Integration (CI) and Continuous Delivery (CD) pipelines automate software development steps.
Bringing performance tests into this flow ensures that performance issues are caught early, before they reach users.
Why k6 in GitHub Actions?
GitHub Actions provides a powerful way to automate tasks directly within your GitHub repository. Here's why it's great for k6 performance tests:
- Automation: Tests run automatically on code changes.
- Consistency: The test environment is standardized.
- Early Feedback: Catch performance regressions quickly.
- Version Control: Your test scripts and workflows live with your code.
GitHub Actions Workflow Basics
A GitHub Actions workflow is defined by a YAML file in the .github/workflows/ directory of your repository.
It specifies when to run, what to run (jobs and steps), and on which operating system.
Our Simple k6 Test Script
Before creating the workflow, let's have a basic k6 script. This script will perform a simple HTTP GET request to a test endpoint. Save this as test.js in your repository.
import http from 'k6/http';
import { check, sleep } from 'k6';
export default function () {
const res = http.get('https://test.k6.io');
check(res, {
'status is 200': (r) => r.status === 200,
});
sleep(1);
}Creating the Workflow File
First, create a new directory .github/workflows/ in the root of your repository. Inside this, create a file named, for example, k6-perf-test.yml.
This file will define our automation steps.
Workflow Structure: Name & Trigger
Every workflow needs a name and a trigger (on). We'll trigger our test on every push to the main branch.
Here's the start of our k6-perf-test.yml file:
name: k6 Performance Test
on:
push:
branches:
- main
jobs:Defining the Test Job
Next, we define a job. A job is a set of steps that execute on the same runner. We'll call ours run-k6-test and use an ubuntu-latest runner.
name: k6 Performance Test
on:
push:
branches:
- main
jobs:
run-k6-test:
runs-on: ubuntu-latest
steps:Checkout Code & Install k6
Inside our job's steps, we first need to check out our repository code, then install k6. We'll use a pre-built GitHub Action to easily install k6.
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install k6
uses: k6io/action@v2.0.0Executing the k6 Test
Finally, we add a step to run our test.js k6 script. We can specify options like the number of virtual users (-u) and duration (-d) directly.
- name: Install k6
uses: k6io/action@v2.0.0
- name: Run k6 test
run: k6 run -u 10 -d 30s test.jsViewing Test Results
After committing your .yml file and test.js script to your GitHub repository, navigate to the Actions tab.
You'll see your workflow running. Click on the workflow run, then the run-k6-test job to view the detailed logs, including k6's output and results.
Workflow Essentials
Which of the following is the correct path and file extension for a GitHub Actions workflow file?
Recap & Next Steps
You've learned how to integrate k6 performance tests into GitHub Actions! This enables automated, consistent, and early performance feedback.
- We explored the workflow structure.
- Set up a k6 script and the YAML workflow file.
- Configured steps for checking out code, installing k6, and running the test.
- Understood how to view results in GitHub Actions.
Next, explore more advanced k6 features in your workflows, like reporting and thresholds!
Frequently asked questions
Is the “k6 in GitHub Actions” lesson free?
Yes — the full text of “k6 in GitHub Actions” is free to read here on the web, and the Load Testing & Performance Benchmarking (JMeter & k6) course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Load Testing & Performance Benchmarking (JMeter & k6) course, upgrade to CoddyKit PRO.
What will I learn in “k6 in GitHub Actions”?
Set up k6 tests to run automatically as part of your GitHub Actions workflows. You practise Load Testing & Performance Benchmarking (JMeter & k6) with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Load Testing & Performance Benchmarking (JMeter & k6)?
No prior experience is required. Load Testing & Performance Benchmarking (JMeter & k6) on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “k6 in GitHub Actions” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Load Testing & Performance Benchmarking (JMeter & k6) lesson?
Yes. Every Load Testing & Performance Benchmarking (JMeter & k6) lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.