Skip to content

Commit

Permalink
fix: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kobenguyent committed Feb 25, 2022
1 parent 9fe7916 commit c033d8e
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,15 +121,18 @@ plugins: {

**Possible config options:**

- `suiteId`: when your project is not under the single-suite mode, `suiteId` is needed. When you don't provide the `suiteId`, the first `suiteId` will be used as default.
- `projectId` (Required): The project Id which is from the Testrail. This should be provided to make this plugin works
- `runName` (Optional): your desired test run name. If you done provide this test run name, default test run name is as `This is a new test run on ${dd/mm/yyy H:M}` which is current day.
- `runId` (Optional): provide the existing run Id when you want to update the existing one instead of creating new testrun.
- `plan - existingPlanId`: if you provide an existing plan ID, the new test run is added to that test plan. Otherwise, new test plan is created and new test run is added to that test plan.
- `plan - name`: your desired plan name.
- `plan - description`: your desired description to your test plan.
- `plan - onlyCaseIds` (Optional): if `true` it will consider only test cases that actually run while posting results to testrail
- `testCase`: if you configured testrail to use custom test case statuses, you can override default status_id with yours.
- `configuration`: provide the created configuration group name - configuration name that you want to add to the test run. If you don't provide anything or wrong either group name or config name, there will be no configuration added to test run.
- `debugLog`: show more logs for debugging purposes.
- `closeTestRun`: by default test run is close afterwards.
| config name | required | Description |
|---|---|---|
| suiteId | yes | when your project is not under the single-suite mode, `suiteId` is needed. When you don't provide the `suiteId`, the first `suiteId` will be used as default. |
| projectId | yes | The project Id which is from the Testrail. This should be provided to make this plugin works |
| runName | no | your desired test run name. If you done provide this test run name, default test run name is as `This is a new test run on ${dd/mm/yyy H:M}` which is current day. |
| runId | no | provide the existing run Id when you want to update the existing one instead of creating new testrun. |
| plan - existingPlanId | no | if you provide an existing plan ID, the new test run is added to that test plan. Otherwise, new test plan is created and new test run is added to that test plan. |
| plan - name | no | your desired plan name. |
| plan - description | no | your desired description to your test plan. |
| plan - onlyCaseIds | no | if `true` it will consider only test cases that actually run while posting results to testrail |
| testCase | no | if you configured testrail to use custom test case statuses, you can override default status_id with yours. |
| configuration | no | provide the created configuration group name - configuration name that you want to add to the test run. If you don't provide anything or wrong either group name or config name, there will be no configuration added to test run. |
| debugLog | no | show more logs for debugging purposes. |
| closeTestRun | no | by default test run is close afterwards. |

0 comments on commit c033d8e

Please sign in to comment.