Skip to content

Commit

Permalink
Updating README.md (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
rbhadti94 authored Jan 18, 2022
1 parent 0576dfa commit 8441308
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This action runs a JMeter performance test using a given JMX test file. It will
## Inputs

### `testFilePath`
**Required**: The path to the JMX test file to run with JMeter
**Required**: The path to the JMX test file to run with JMeter. Can also specify a folder, in which case all JMX files in that folder will be run.

### `outputReportsFolder`
**Not Required**: The folder in which the JMeter reports are produced.
Expand All @@ -28,19 +28,28 @@ Please see https://jmeter.apache.org/usermanual/get-started.html for more inform
# Use JMeter to run the JMX test case and produce reports in the "reports/"
# directory in the workspace.
- name: Run JMeter Tests
uses: rbhadti94/apache-jmeter-action@v0.3.1
uses: rbhadti94/apache-jmeter-action@v0.5.0
with:
testFilePath: tests/sample_test.jmx
outputReportsFolder: reports/

# Use JMeter to run the JMX test case.
# Modify the logging level and pass in some custom properties and config
- name: Run JMeter Tests with modified logging and custom properties
uses: rbhadti94/apache-jmeter-action@v0.3.1
uses: rbhadti94/apache-jmeter-action@v0.5.0
with:
testFilePath: tests/sample_test.jmx
outputReportsFolder: reports/
args: "--loglevel INFO -JMyProperty=Value --jmeterlogconf=log.conf"

# Use JMeter to run all tests in a folder
# Modify the logging level and pass in some custom properties and config
- name: Run All JMeter Tests In tests Folder
uses: rbhadti94/[email protected]
with:
testFilePath: tests/
outputReportsFolder: reports/
args: "--loglevel INFO -JMyProperty=Value --jmeterlogconf=log.conf"
```
### Full Example Usage
Expand All @@ -62,15 +71,27 @@ jobs:
steps:
- uses: actions/checkout@v2

- name: Run JMeter Action
uses: ./
- name: Run JMeter Action on a test
uses: rbhadti94/[email protected]
with:
testFilePath: tests/sample_test.jmx
outputReportsFolder: reports/
args: "--loglevel INFO"

- name: Run JMeter Action on other tests
uses: rbhadti94/[email protected]
with:
testFilePath: other-tests/
outputReportsFolder: other_reports/
args: "--loglevel INFO"

- uses: actions/upload-artifact@v1
with:
name: jmeter-test-results
path: reports/

- uses: actions/upload-artifact@v1
with:
name: jmeter-test-results-other
path: other_reports/
```

0 comments on commit 8441308

Please sign in to comment.