A GitHub Action for performing customizable load testing using the Burden CLI tool, written in Go. This Action is designed for developers and DevOps engineers who want to integrate performance testing into their CI/CD pipelines.
- Supports multiple HTTP methods (GET, POST, PUT, DELETE, etc.).
- Allows specification of various load testing parameters.
- Outputs key metrics (Throughput, Response Time, Latency).
- Configurable detailed reporting for comprehensive performance analysis.
Add the following to your workflow file (e.g., .github/workflows/load-test.yml):
name: Load Test
on:
push:
branches:
- main
jobs:
load-test:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Run Load Testing Action
uses: burden-load/action@v1
with:
url: 'https://example.com/api'
method: 'GET'
users: 10
requests: 100
| Name | Description | Required | Default |
|---|---|---|---|
url |
The target URL for the load test. | Yes | N/A |
method |
HTTP method for requests (e.g., GET, POST). | No | GET |
users |
Number of concurrent users for the test. | No | 1 |
requests |
Total number of requests to perform. | No | 100 |
duration |
Test duration in seconds (alternative to requests). |
No | N/A |
detailed_report |
Set to true for a full report. |
No | false |
- name: Run Load Testing with Detailed Report
uses: burden-load/action@v1
with:
url: 'https://example.com/api'
method: 'POST'
users: 20
duration: 60
detailed_report: true
After the test, the Action will output basic metrics to the workflow logs. If detailed_report is enabled, the Action will provide additional metrics, such as error rates and peak load.
This project is licensed under the MIT License - see the LICENSE file for details.