{"id":18234054,"url":"https://github.com/thomasvjoseph/locust","last_synced_at":"2025-10-07T02:00:05.279Z","repository":{"id":259194607,"uuid":"876654301","full_name":"thomasvjoseph/locust","owner":"thomasvjoseph","description":"Locust Integration in Github Actions and generates HTML reports for analysis.","archived":false,"fork":false,"pushed_at":"2024-10-23T09:27:17.000Z","size":14,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T20:38:03.813Z","etag":null,"topics":["cicd","devops","github-actions","load-testing","locust","open-source","python"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thomasvjoseph.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-22T10:39:52.000Z","updated_at":"2024-11-08T10:21:35.000Z","dependencies_parsed_at":"2024-10-23T11:55:57.194Z","dependency_job_id":null,"html_url":"https://github.com/thomasvjoseph/locust","commit_stats":null,"previous_names":["thomasvjoseph/locust"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/thomasvjoseph/locust","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasvjoseph%2Flocust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasvjoseph%2Flocust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasvjoseph%2Flocust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasvjoseph%2Flocust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thomasvjoseph","download_url":"https://codeload.github.com/thomasvjoseph/locust/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomasvjoseph%2Flocust/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278708007,"owners_count":26031932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cicd","devops","github-actions","load-testing","locust","open-source","python"],"created_at":"2024-11-04T17:03:18.177Z","updated_at":"2025-10-07T02:00:05.239Z","avatar_url":"https://github.com/thomasvjoseph.png","language":"Shell","readme":"# Locust GitHub Action\n\nThis GitHub Action allows you to run Locust performance tests in your CI/CD pipeline. You can easily configure and run load tests on your web application and download the results in HTML format.\n\n## Table of Contents\n\n- [Features](#features)\n- [Inputs](#inputs)\n- [Usage](#usage)\n- [License](#license)\n\n## Features\n\n- Run load tests using a custom Locust file or a default script.\n- Install dependencies using Poetry.\n- Flexible configuration options for user count, hatch rate, and test duration.\n- Supports running Locust in headless mode.\n\n## Usage\n\nTo use the Locust GitHub Action in your workflows, include it in your workflow YAML file:\n\n### Example Workflow\n\n```yaml\nname: Load Test\n\non: [push]\n\njobs:\n  locust-test:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@v4\n\n      - name: Run Locust Performance Tests\n        uses: thomasvjoseph/locust@v1.1.7\n        with:\n          URL: https://yourwebsite.com   # Replace with your target URL\n          LOCUSTFILE: locustfile.py      # Path to your Locustfile\n          USERS: 2                       # Number of concurrent users\n          RATE: 1                        # Rate of user spawning\n          RUNTIME: 10s                   # Duration of the test\n          HEADLESS: true                 # Run Locust in headless mode\n          LOGLEVEL: DEBUG                # Set logging level\n          html_report: 'example.html'    # Name of the HTML report file\n\n      - name: Upload Locust Test Results\n        uses: actions/upload-artifact@v4\n        with:\n          name: locust-report            # Name of the artifact\n          path: example.html             # Path to the generated HTML report\n          if-no-files-found: warn        # Warn if no files are found\n          retention-days: 1              # Retention period for the artifact\n\n```\n\n## Inputs\n\n| Input          | Description                                                                                      | Required | Default        |\n|----------------|--------------------------------------------------------------------------------------------------|----------|----------------|\n| `LOCUSTFILE`   | The locustfile you want to use to load test. If not provided, a default locustfile will be used. | No       | `locustfile.py`|\n| `REQUIREMENTS` | pyproject.toml file you want to use to install 3rd party dependencies.                           | No       | N/A            |\n| `URL`          | URL to the site you want to load test.                                                           | Yes      | N/A            |\n| `USERS`        | Number of users to spawn.                                                                        | No       | `5`            |\n| `RATE`         | Hatch rate (number of users to spawn per second).                                                | No       | `5`            |\n| `RUNTIME`      | Run time for the test.                                                                           | No       | `10s`          |\n| `HEADLESS`     | Run Locust in headless mode (no web UI).                                                         | No       | `true`         |\n| `LOGLEVEL`     | Specify the log level (DEBUG, INFO, WARNING, ERROR, CRITICAL).                                   | No       | `INFO`         |\n| `MASTER`       | Run as Locust master in distributed mode.                                                        | No       | `false`        | \n| `WORKERS`      | Number of worker nodes to run in distributed mode (if MASTER is true).                           | No       | `1`            |\n\n\n\n## License\n\nThis project is licensed under the MIT License. See [LICENSE](LICENSE) for more details.\n\n## Contributing\n\nFeel free to open an issue or submit a pull request to improve the module.\n\n## Author:  \nthomas joseph\n- [linkedin](https://www.linkedin.com/in/thomas-joseph-88792b132/)\n- [medium](https://medium.com/@thomasvjoseph)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomasvjoseph%2Flocust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthomasvjoseph%2Flocust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomasvjoseph%2Flocust/lists"}