@serenity-js/webdriverio-8 3.36.2 → 3.37.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 (3) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +44 -25
  3. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.37.0](https://github.com/serenity-js/serenity-js/compare/v3.36.2...v3.37.0) (2025-12-02)
7
+
8
+ **Note:** Version bump only for package @serenity-js/webdriverio-8
9
+
10
+
11
+
12
+
13
+
6
14
  ## [3.36.2](https://github.com/serenity-js/serenity-js/compare/v3.36.1...v3.36.2) (2025-11-26)
7
15
 
8
16
  **Note:** Version bump only for package @serenity-js/webdriverio-8
package/README.md CHANGED
@@ -1,9 +1,16 @@
1
- # Serenity/JS with WebdriverIO 8 🚀
1
+ # Serenity/JS WebdriverIO
2
+
3
+ [![NPM Version](https://badge.fury.io/js/%40serenity-js%2Fwebdriverio-8.svg)](https://badge.fury.io/js/%40serenity-js%2Fwebdriverio-8)
4
+ [![Build Status](https://github.com/serenity-js/serenity-js/actions/workflows/main.yaml/badge.svg?branch=main)](https://github.com/serenity-js/serenity-js/actions)
5
+ [![Maintainability](https://qlty.sh/gh/serenity-js/projects/serenity-js/maintainability.svg)](https://qlty.sh/gh/serenity-js/projects/serenity-js)
6
+ [![Code Coverage](https://qlty.sh/gh/serenity-js/projects/serenity-js/coverage.svg)](https://qlty.sh/gh/serenity-js/projects/serenity-js)
7
+ [![Contributors](https://img.shields.io/github/contributors/serenity-js/serenity-js.svg)](https://github.com/serenity-js/serenity-js/graphs/contributors)
8
+ [![Known Vulnerabilities](https://snyk.io/test/npm/@serenity-js/webdriverio-8/badge.svg)](https://snyk.io/test/npm/@serenity-js/webdriverio-8)
9
+ [![GitHub stars](https://img.shields.io/github/stars/serenity-js/serenity-js?style=flat)](https://github.com/serenity-js/serenity-js)
2
10
 
3
11
  [![Follow Serenity/JS on LinkedIn](https://img.shields.io/badge/Follow-Serenity%2FJS%20-0077B5?logo=linkedin)](https://www.linkedin.com/company/serenity-js)
4
12
  [![Watch Serenity/JS on YouTube](https://img.shields.io/badge/Watch-@serenity--js-E62117?logo=youtube)](https://www.youtube.com/@serenity-js)
5
13
  [![Join Serenity/JS Community Chat](https://img.shields.io/badge/Chat-Serenity%2FJS%20Community-FBD30B?logo=matrix)](https://matrix.to/#/#serenity-js:gitter.im)
6
- [![GitHub stars](https://img.shields.io/github/stars/serenity-js/serenity-js?label=Serenity%2FJS&logo=github&style=badge)](https://github.com/serenity-js/serenity-js)
7
14
  [![Support Serenity/JS on GitHub](https://img.shields.io/badge/Support-@serenity--js-703EC8?logo=github)](https://github.com/sponsors/serenity-js)
8
15
 
9
16
  [Serenity/JS](https://serenity-js.org) revolutionises automated testing by enabling your team to write **expressive**, **maintainable tests** that align
@@ -17,16 +24,16 @@ helping both technical teams and business stakeholders understand the quality of
17
24
  Serenity/JS WebdriverIO 8 module is intended for existing projects that can't yet upgrade to WebdriverIO 9.
18
25
  If you're starting a new project, we recommend using the [Serenity/JS WebdriverIO module](https://serenity-js.org/api/webdriverio/).
19
26
 
20
- ## 🚀 Why choose Serenity/JS?
27
+ ## Features
21
28
 
22
29
  - Write **expressive**, **maintainable** tests that align with your unique domain using the [**Serenity/JS Screenplay Pattern**](https://serenity-js.org/handbook/design/screenplay-pattern) APIs.
23
30
  - **Leverage advanced reporting** to track progress, detect failures, and share results with both technical and business stakeholders.
24
31
  - Build on flexible, modular, and extensible architecture that supports a wide range of test automation needs.
25
32
  - Integrate with WebdriverIO 8 and modern test automation tools.
26
33
 
27
- ## 🛠️ Integrate WebdriverIO 8 with Serenity/JS in 4 steps
34
+ ## Quick Start
28
35
 
29
- ### 1. Installing Serenity/JS modules
36
+ ### Installation
30
37
 
31
38
  To add Serenity/JS to an existing WebdriverIO 8 project, install the following Serenity/JS modules from NPM:
32
39
 
@@ -45,7 +52,7 @@ Learn more about Serenity/JS modules:
45
52
 
46
53
  If you prefer to review a reference implementation first, clone a [Serenity/JS Project Template](https://serenity-js.org/handbook/project-templates/) for your preferred test runner.
47
54
 
48
- ### 2. Configuring Serenity/JS
55
+ ### Configuring Serenity/JS
49
56
 
50
57
  To enable integration with Serenity/JS, configure WebdriverIO as follows:
51
58
 
@@ -128,7 +135,7 @@ Learn more about:
128
135
  - [Serenity/JS Mocha configuration options](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/)
129
136
  - [WebdriverIO configuration file](https://webdriver.io/docs/configurationfile/)
130
137
 
131
- ### 3. Generating Serenity BDD reports and living documentation
138
+ ### Reporting
132
139
 
133
140
  [Serenity BDD reports and living documentation](https://serenity-bdd.github.io/docs/reporting/the_serenity_reports) are generated by [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-core/tree/main/serenity-cli),
134
141
  a Java program provided by the [`@serenity-js/serenity-bdd`](https://serenity-js.org/api/serenity-bdd/) module.
@@ -158,7 +165,7 @@ To learn more about the `SerenityBDDReporter`, please consult:
158
165
  - configuration examples in [`SerenityBDDReporter` API docs](https://serenity-js.org/api/serenity-bdd/class/SerenityBDDReporter/),
159
166
  - [Serenity/JS examples on GitHub](https://github.com/serenity-js/serenity-js/tree/main/examples).
160
167
 
161
- ### 4. Writing a test scenario
168
+ ### Writing a test scenario
162
169
 
163
170
  Assuming you're using WebdriverIO 8 with Mocha, create a test file under `./test/specs/example.spec.ts` with the following contents:
164
171
 
@@ -197,7 +204,7 @@ allowing you to switch to `@serenity-js/webdriverio` whenever you're ready to up
197
204
  You can learn more about these and other Serenity/JS modules in the [Serenity/JS API documentation](https://serenity-js.org/api/).
198
205
  You might also want to check out the [Serenity/JS WebdriverIO integration guide](https://serenity-js.org/handbook/test-runners/webdriverio/) for more details on configuring your framework.
199
206
 
200
- ### 4. Running your tests and generating reports
207
+ ### Running your tests and generating reports
201
208
 
202
209
  To run your tests and generate Serenity/JS reports, execute the following command in your terminal:
203
210
 
@@ -208,27 +215,39 @@ npm test
208
215
  Your test results will be available in the `target/site/serenity` directory.
209
216
  To view them, open the `index.html` file in your preferred web browser.
210
217
 
211
- ## 💡️ Learn Serenity/JS
218
+ ## Documentation
219
+
220
+ - [API Reference](https://serenity-js.org/api/)
221
+ - [Screenplay Pattern Guide](https://serenity-js.org/handbook/design/screenplay-pattern/)
222
+ - [Serenity/JS Project Templates](https://serenity-js.org/handbook/project-templates/)
223
+ - [More examples and reference implementations](https://github.com/serenity-js/serenity-js/tree/main/examples)
224
+ - [Tutorial: First Web Scenario](https://serenity-js.org/handbook/tutorials/your-first-web-scenario/)
225
+ - [Tutorial: First API Scenario](https://serenity-js.org/handbook/tutorials/your-first-api-scenario/)
226
+
227
+ ## Contributing
228
+
229
+ Contributions of all kinds are welcome! Get started with the [Contributing Guide](https://serenity-js.org/community/contributing/).
230
+
231
+ ## Community
232
+
233
+ - [Community Chat](https://matrix.to/#/#serenity-js:gitter.im)
234
+ - [Discussions Forum](https://github.com/orgs/serenity-js/discussions)
235
+ - Visit the [💡How to... ?](https://github.com/orgs/serenity-js/discussions/categories/how-to) section for answers to common questions
212
236
 
213
- - [Serenity/JS WebdriverIO integration guide](https://serenity-js.org/handbook/test-runners/webdriverio/) - Integrate Serenity/JS with your WebdriverIO test suite, enable Serenity BDD reports, and start using the Screenplay Pattern
214
- - [Serenity/JS Handbook](https://serenity-js.org/handbook/) - Write high-quality automated acceptance tests with Serenity/JS
215
- - [Serenity/JS API documentation](https://serenity-js.org/api/) - Explore Serenity/JS modules and features
216
- - [Serenity/JS Project Templates](https://serenity-js.org/handbook/project-templates/) - Kickstart your projects with best practices built right in
237
+ If you enjoy using Serenity/JS, make sure to star ⭐️ [Serenity/JS on GitHub](https://github.com/serenity-js/serenity-js) to help others discover the framework!
217
238
 
218
- ## 👋 Join the Serenity/JS Community
239
+ ## License
219
240
 
220
- - [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im) - Meet Serenity/JS developers and maintainers
221
- - [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-to) - Find answers to your Serenity/JS questions
222
- - [Contribute to Serenity/JS](https://serenity-js.org/community/contributing/) - Learn how to propose features, report bugs, and contribute to the Serenity/JS codebase
241
+ The Serenity/JS code base is licensed under the [Apache-2.0](https://opensource.org/license/apache-2-0) license,
242
+ while its documentation and the [Serenity/JS Handbook](https://serenity-js.org/handbook/) are licensed under the [Creative Commons BY-NC-SA 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/).
223
243
 
224
- ## 📣 Stay up to date
244
+ See the [Serenity/JS License](https://serenity-js.org/legal/license/).
225
245
 
226
- - [Serenity/JS on YouTube](https://www.youtube.com/@serenity-js) - Subscribe for tutorials, demos, conference talks, and more
227
- - [Serenity/JS on LinkedIn](https://www.linkedin.com/company/serenity-js) - Follow for release and community event announcements
228
- - [Serenity/JS on GitHub](https://github.com/serenity-js/serenity-js) - Star Serenity/JS to help others discover the framework!
246
+ ## Support
229
247
 
230
- ## 💛 Support Serenity/JS
248
+ Support ongoing development through [GitHub Sponsors](https://github.com/sponsors/serenity-js). Sponsors gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks)
249
+ and priority help in the [Discussions Forum](https://github.com/orgs/serenity-js/discussions).
231
250
 
232
- Support our mission to make test automation collaborative and easier to scale. Become a Serenity/JS GitHub Sponsor today!
251
+ For corporate sponsorship or commercial support, please contact [Jan Molak](https://www.linkedin.com/in/janmolak/).
233
252
 
234
- [![GitHub Sponsors](https://img.shields.io/badge/Sponsor%20@serenity%2FJS-703EC8?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sponsors/serenity-js)
253
+ [![GitHub Sponsors](https://img.shields.io/badge/Support%20@serenity%2FJS-703EC8?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sponsors/serenity-js).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@serenity-js/webdriverio-8",
3
- "version": "3.36.2",
3
+ "version": "3.37.0",
4
4
  "description": "Adapter that integrates @serenity-js/web with WebdriverIO 8, enabling Serenity/JS reporting and using the Screenplay Pattern to write web and mobile test scenarios",
5
5
  "author": {
6
6
  "name": "Jan Molak",
@@ -74,9 +74,9 @@
74
74
  "node": "^20 || ^22 || ^24"
75
75
  },
76
76
  "dependencies": {
77
- "@serenity-js/core": "3.36.2",
78
- "@serenity-js/rest": "3.36.2",
79
- "@serenity-js/web": "3.36.2",
77
+ "@serenity-js/core": "3.37.0",
78
+ "@serenity-js/rest": "3.37.0",
79
+ "@serenity-js/web": "3.37.0",
80
80
  "@wdio/reporter": "8.43.0",
81
81
  "deepmerge": "4.3.1",
82
82
  "tiny-types": "1.24.3"
@@ -118,5 +118,5 @@
118
118
  "start-server-and-test": "2.1.3",
119
119
  "webdriverio": "8.46.0"
120
120
  },
121
- "gitHead": "bce71a2454b8c6e2639bc351cc84f47c0c8cbb0a"
121
+ "gitHead": "dae146cd99a04f09b5926fb9d3205af562fa2927"
122
122
  }