Skip to content

Commit e5049e3

Browse files
committed
qase-cypress: release 2.0.0-beta.2
Update a few lines in the readme.
1 parent ab0aa03 commit e5049e3

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

qase-cypress/README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,31 @@ Publish results simple and easy.
88
npm install -D cypress-qase-reporter@beta
99
```
1010

11-
## Example of usage
11+
## Getting started
1212

13-
The Cypress reporter has the ability to auto-generate test cases
13+
The Cypress reporter can auto-generate test cases
1414
and suites from your test data.
15+
Test results of subsequent test runs will match the same test cases
16+
as long as their names and file paths don't change.
1517

16-
But if necessary, you can independently register the ID of already
17-
existing test cases from TMS before the executing tests. For example:
18+
You can also annotate the tests with the IDs of existing test cases
19+
from Qase.io before executing tests. It's a more reliable way to bind
20+
autotests to test cases, that persists when you rename, move, or
21+
parameterize your tests.
22+
23+
For example:
1824

1925
```typescript
2026
import { qase } from 'cypress-qase-reporter/mocha';
2127

2228
describe('My First Test', () => {
23-
qase([1, 2],
29+
qase(1,
2430
it('Several ids', () => {
2531
expect(true).to.equal(true);
2632
})
2733
);
28-
qase(3,
34+
// a test can check multiple test cases
35+
qase([2, 3],
2936
it('Correct test', () => {
3037
expect(true).to.equal(true);
3138
})
@@ -36,10 +43,9 @@ describe('My First Test', () => {
3643
})
3744
);
3845
});
39-
4046
```
4147

42-
To run tests and create a test run, execute the command (for example from folder examples):
48+
To execute Cypress tests and report them to Qase.io, run the command:
4349

4450
```bash
4551
QASE_MODE=testops npx cypress run
@@ -51,6 +57,8 @@ or
5157
npm test
5258
```
5359

60+
You can try it with the example project at [`examples/cypress`](../examples/cypress/).
61+
5462
<p align="center">
5563
<img width="65%" src="./screenshots/screenshot.png">
5664
</p>
@@ -64,8 +72,9 @@ https://app.qase.io/run/QASE_PROJECT_CODE
6472
## Configuration
6573

6674
Qase Cypress reporter can be configured in multiple ways:
67-
- using a config file `qase.config.json`
68-
- using environment variables
75+
- by adding configuration block in `cypress.config.js`,
76+
- using a separate config file `qase.config.json`,
77+
- using environment variables (they override the values from the configuration files).
6978

7079
For a full list of configuration options, see the [Configuration reference](../qase-javascript-commons/README.md#configuration).
7180

@@ -115,7 +124,8 @@ module.exports = cypress.defineConfig({
115124
});
116125
```
117126

118-
### You can check example configuration with multiple reporters in [demo project](../examples/cypress/cypress.config.js).
127+
Check out the example of configuration for multiple reporters in the
128+
[demo project](../examples/cypress/cypress.config.js).
119129

120130
## Requirements
121131

0 commit comments

Comments
 (0)