https://github.com/artilleryio/action-cli
GitHub Action for load testing with Artillery.
https://github.com/artilleryio/action-cli
Last synced: 3 months ago
JSON representation
GitHub Action for load testing with Artillery.
- Host: GitHub
- URL: https://github.com/artilleryio/action-cli
- Owner: artilleryio
- License: mpl-2.0
- Created: 2023-07-10T12:25:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T00:28:34.000Z (over 1 year ago)
- Last Synced: 2025-06-16T14:03:31.429Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 114 KB
- Stars: 16
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Artillery GitHub Action
Official GitHub Action for running load tests with Artillery.
## Inputs
### `command`
The Artillery CLI command to run. You can use all the available commands:
- [`run`](https://www.artillery.io/docs/reference/cli/run)
- [`run-fargate`](https://www.artillery.io/docs/reference/cli/run-fargate)
- [`run-lambda`](https://www.artillery.io/docs/reference/cli/run-lambda)
```yml
- name: Load tests
uses: artilleryio/action-cli@v1
with:
command: run ./preprod.yml
```
> Learn more about [Writing test scripts with Artillery](https://www.artillery.io/docs/get-started/first-test).
### `working-directory`
- _Optional_
Path to a directory to use as the current working directory when running Artillery commands.
```yml
- name: Load tests
uses: artilleryio/action-cli@v1
with:
command: run ./test.yml
working-directory: ./packages/app/load-tests
```
## Outputs
This action does not set any outputs.
You can generate and access the test run report using the CLI directly:
```yml
- name: Load tests
uses: artilleryio/action-cli@v1
with:
# Save the test run report at "./report.json"
command: run ./prod.yml --output ./report.json
- name: Upload artifact
uses: actions/upload-artifact@v3
if: always()
with:
name: artillery-report
# Reference the generated report in the file system.
path: ./report.json
```
## Usage examples
Learn more about [Running Artillery on GitHub Actions](https://www.artillery.io/docs/cicd/github-actions).
## Bugs / Questions
Talk to us in the main [`artilleryio/artillery`](https://github.com/artilleryio/artillery) repo
- [Issues](https://github.com/artilleryio/artillery/issues)
- [Discussions](https://github.com/artilleryio/artillery/discussions/categories/artillery)