Skip to content

GitHub Action for load testing with Artillery.

License

Notifications You must be signed in to change notification settings

artilleryio/action-cli

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

GitHub Actions icon

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:

- name: Load tests
  uses: artilleryio/action-cli@v1
  with:
    command: run ./preprod.yml

Learn more about Writing test scripts with Artillery.

working-directory

  • Optional

Path to a directory to use as the current working directory when running Artillery commands.

- 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:

- 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.

Bugs / Questions

Talk to us in the main artilleryio/artillery repo