cypress-qase-reporter 3.0.0-beta.2 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +59 -55
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,12 +4,67 @@ Publish results simple and easy.
4
4
 
5
5
  ## Installation
6
6
 
7
- To install the latest release version (2.2.x), run:
7
+ To install the latest release version, run:
8
8
 
9
9
  ```sh
10
10
  npm install -D cypress-qase-reporter
11
11
  ```
12
12
 
13
+ ## Updating from v2.3.x to v3.0.x
14
+
15
+ To update an existing test project using Qase reporter from version 2.3.x to version 3.0.x,
16
+ run the following steps:
17
+
18
+ - Update reporter configuration in `cypress.config.js` file.
19
+
20
+ ```diff
21
+ + import { afterSpecHook } from 'cypress-qase-reporter/hooks';
22
+ ...
23
+ reporter: 'cypress-multi-reporters',
24
+ reporterOptions: {
25
+ reporterEnabled: 'cypress-qase-reporter',
26
+ cypressQaseReporterReporterOptions: {
27
+ ... // other options
28
+ framework: {
29
+ cypress: {
30
+ screenshotsFolder: 'cypress/screenshots',
31
+ + videosFolder: 'cypress/videos',
32
+ + uploadDelay: 10, // Delay in seconds before uploading video files (default: 10)
33
+ },
34
+ },
35
+ },
36
+ },
37
+ video: true,
38
+ e2e: {
39
+ setupNodeEvents(on, config) {
40
+ require('cypress-qase-reporter/plugin')(on, config)
41
+ require('cypress-qase-reporter/metadata')(on)
42
+ + on('after:spec', async (spec, results) => {
43
+ + await afterSpecHook(spec, config);
44
+ + });
45
+ }
46
+ }
47
+ ...
48
+ ```
49
+
50
+ ## Updating from v2.1 to v2.2
51
+
52
+ To update an existing test project using Qase reporter from version 2.1 to version 2.2,
53
+ run the following steps:
54
+
55
+ - Add metadata in the `e2e` section of `cypress.config.js`
56
+
57
+ ```diff
58
+ ...
59
+ e2e: {
60
+ setupNodeEvents(on, config) {
61
+ require('cypress-qase-reporter/plugin')(on, config)
62
+ + require('cypress-qase-reporter/metadata')(on)
63
+ }
64
+ }
65
+ ...
66
+ ```
67
+
13
68
  ## Updating from v1 to v2.1
14
69
 
15
70
  To update an existing test project using Qase reporter from version 1 to version 2.1,
@@ -59,60 +114,6 @@ run the following steps:
59
114
  ...
60
115
  ```
61
116
 
62
- ## Updating from v2.1 to v2.2
63
-
64
- To update an existing test project using Qase reporter from version 2.1 to version 2.2,
65
- run the following steps:
66
-
67
- 1. Add a metadata in the `e2e` section of `cypress.config.js`
68
-
69
- ```diff
70
- ...
71
- e2e: {
72
- setupNodeEvents(on, config) {
73
- require('cypress-qase-reporter/plugin')(on, config)
74
- + require('cypress-qase-reporter/metadata')(on)
75
- }
76
- }
77
- ...
78
-
79
- ## Updating from v2.3.x to v3.0.0-beta.2
80
-
81
- To update an existing test project using Qase reporter from version 2.3.x to version 3.0.0-beta.2,
82
- run the following steps:
83
-
84
- 1. Update reporter configuration in `cypress.config.js` file.
85
-
86
- ```diff
87
- + import { afterSpecHook } from 'cypress-qase-reporter/hooks';
88
- ...
89
- reporter: 'cypress-multi-reporters',
90
- reporterOptions: {
91
- reporterEnabled: 'cypress-qase-reporter',
92
- cypressQaseReporterReporterOptions: {
93
- ... // other options
94
- framework: {
95
- cypress: {
96
- screenshotsFolder: 'cypress/screenshots',
97
- + videosFolder: 'cypress/videos',
98
- + uploadDelay: 10, // Delay in seconds before uploading video files (default: 10)
99
- },
100
- },
101
- },
102
- },
103
- video: true,
104
- e2e: {
105
- setupNodeEvents(on, config) {
106
- require('cypress-qase-reporter/plugin')(on, config)
107
- require('cypress-qase-reporter/metadata')(on)
108
- + on('after:spec', async (spec, results) => {
109
- + await afterSpecHook(spec, config);
110
- + });
111
- }
112
- }
113
- ...
114
- ```
115
-
116
117
  ## Getting started
117
118
 
118
119
  The Cypress reporter can auto-generate test cases
@@ -233,6 +234,7 @@ module.exports = cypress.defineConfig({
233
234
  cypress: {
234
235
  screenshotsFolder: 'cypress/screenshots',
235
236
  videosFolder: 'cypress/videos',
237
+ uploadDelay: 10, // Delay in seconds before uploading video files (default: 10)
236
238
  }
237
239
  }
238
240
  },
@@ -287,6 +289,8 @@ module.exports = cypress.defineConfig({
287
289
  framework: {
288
290
  cypress: {
289
291
  screenshotsFolder: 'cypress/screenshots',
292
+ videosFolder: 'cypress/videos',
293
+ uploadDelay: 10, // Delay in seconds before uploading video files (default: 10)
290
294
  },
291
295
  },
292
296
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cypress-qase-reporter",
3
- "version": "3.0.0-beta.2",
3
+ "version": "3.0.0",
4
4
  "description": "Qase Cypress Reporter",
5
5
  "homepage": "https://github.com/qase-tms/qase-javascript",
6
6
  "sideEffects": false,
@@ -51,7 +51,7 @@
51
51
  "author": "Qase Team <support@qase.io>",
52
52
  "license": "Apache-2.0",
53
53
  "dependencies": {
54
- "qase-javascript-commons": "~2.4.0-beta.1",
54
+ "qase-javascript-commons": "~2.4.0",
55
55
  "uuid": "^9.0.1"
56
56
  },
57
57
  "peerDependencies": {