Skip to content

Commit

Permalink
refactor: add links to Testrail doc to clarify custom fields config
Browse files Browse the repository at this point in the history
  • Loading branch information
@axules
axules committed Oct 1, 2024
1 parent af733f9 commit 6f94a34
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,24 +147,24 @@ plugins: {

### Possible config options:

| 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 |
| prefixTag | no | By default it is set to`'@C'` |
| 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, or your custom comment. |
| 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 | If you wish to close the test run afterwards,by default test run is not closed afterwards. |
| skipInfo - message | no | Message to comment for skipped cases |
| version | no | Build version. E.g. `version: packageJson.version` |
| <span id="resultProcessorSpec">resultProcessor</span> | no | `function(testResult, { testCase, allResults, allTestCases })`.<br/>It is expected to return test result object (you could add/replace in this object any required fields to follow your Testrail configuration).<br/>If this function returns `null` then this result will not be sent to Testrail. |
| 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 |
| prefixTag | no | By default it is set to`'@C'` |
| 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, or your custom comment. |
| 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 | If you wish to close the test run afterwards,by default test run is not closed afterwards. |
| skipInfo - message | no | Message to comment for skipped cases |
| version | no | Build version. E.g. `version: packageJson.version` |
| resultProcessor | no | `function(testResult, { testCase, allResults, allTestCases })`.<br/>It is expected to return test result object (you could add/replace in this object any required [custom fields](https://support.testrail.com/hc/en-us/articles/7373850291220-Configuring-custom-fields) to follow your [Testrail configuration](https://support.testrail.com/hc/en-us/articles/7077871398036-Result-Fields)).<br/>If this function returns `null` then this result will not be sent to Testrail. |

## Contributing

Expand Down

0 comments on commit 6f94a34

Please sign in to comment.