This project demonstrates how to use k6, an open-source load testing tool, with GitHub Actions for continuous performance testing. The setup allows you to easily integrate performance testing into your CI/CD pipeline.
Before using this project, ensure you have the following:
- k6
- A GitHub repository where you want to integrate performance testing.
-
Clone this repository to your local machine:
git clone https://github.com/maxoliverbr/k6GithubActions.git
-
Navigate to the project directory:
cd k6GithubActions
-
Customize your k6 test script in the
scripts
directory. You can use the providedexample.js
as a starting point. -
Update the GitHub Actions workflow configuration in
.github/workflows/k6.yml
as needed, specifying your test script and other parameters.
To run the k6 test locally, use the following command:
k6 run scripts/example.js