Skip to content

Commit 173c9d9

Browse files
committed
docs(website): upgraded Serenity/JS to 3.31.13 to update the API docs
1 parent 9130c6e commit 173c9d9

File tree

10 files changed

+5512
-1379
lines changed

10 files changed

+5512
-1379
lines changed

package-lock.json

Lines changed: 5483 additions & 1347 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,21 @@
3131
"@docusaurus/theme-mermaid": "3.7.0",
3232
"@giscus/react": "3.1.0",
3333
"@mdx-js/react": "3.1.0",
34-
"@serenity-js/assertions": "3.31.12",
35-
"@serenity-js/console-reporter": "3.31.12",
36-
"@serenity-js/core": "3.31.12",
37-
"@serenity-js/cucumber": "3.31.12",
38-
"@serenity-js/jasmine": "3.31.12",
39-
"@serenity-js/local-server": "3.31.12",
40-
"@serenity-js/mocha": "3.31.12",
41-
"@serenity-js/playwright": "3.31.12",
42-
"@serenity-js/playwright-test": "3.31.12",
43-
"@serenity-js/protractor": "3.31.12",
44-
"@serenity-js/rest": "3.31.12",
45-
"@serenity-js/serenity-bdd": "3.31.12",
46-
"@serenity-js/web": "3.31.12",
47-
"@serenity-js/webdriverio": "3.31.12",
48-
"@serenity-js/webdriverio-8": "3.31.12",
34+
"@serenity-js/assertions": "3.31.13",
35+
"@serenity-js/console-reporter": "3.31.13",
36+
"@serenity-js/core": "3.31.13",
37+
"@serenity-js/cucumber": "3.31.13",
38+
"@serenity-js/jasmine": "3.31.13",
39+
"@serenity-js/local-server": "3.31.13",
40+
"@serenity-js/mocha": "3.31.13",
41+
"@serenity-js/playwright": "3.31.13",
42+
"@serenity-js/playwright-test": "3.31.13",
43+
"@serenity-js/protractor": "3.31.13",
44+
"@serenity-js/rest": "3.31.13",
45+
"@serenity-js/serenity-bdd": "3.31.13",
46+
"@serenity-js/web": "3.31.13",
47+
"@serenity-js/webdriverio": "3.31.13",
48+
"@serenity-js/webdriverio-8": "3.31.13",
4949
"clsx": "2.1.1",
5050
"docusaurus-plugin-sass": "0.2.6",
5151
"docusaurus-plugin-typedoc-api": "4.4.0",
@@ -81,8 +81,8 @@
8181
]
8282
},
8383
"overrides": {
84-
"@wdio/cli": "^9.4.1",
85-
"webdriverio": "^9.4.1"
84+
"@wdio/cli": "9.x",
85+
"webdriverio": "9.x"
8686
},
8787
"engines": {
8888
"node": ">=18.0"

src/docs/handbook/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Serenity/JS is designed to help you safely and progressively modernise **existin
9595

9696
- [**Serenity/JS with Playwright Test**](/handbook/test-runners/playwright-test/): Learn how to integrate Serenity/JS reporting services and Screenplay Pattern APIs with your Playwright Test project.
9797
- [**Serenity/JS with WebdriverIO**](/handbook/test-runners/webdriverio/): Learn how Serenity/JS can help you improve your WebdriverIO 8 and WebdriverIO 9 projects.
98-
- [**Migrating from Protractor**](/handbook/tutorials/protractor/): Migrate from Protractor to WebdriverIO or Playwright Test using the Serenity/JS web module.
98+
- [**Migrating from Protractor**](/handbook/test-runners/protractor/): Migrate from Protractor to WebdriverIO or Playwright Test using the Serenity/JS web module.
9999
- [**Upgrading from Serenity/JS 2**](/handbook/tutorials/upgrading-from-serenity-js-2/): Upgrade from Serenity/JS 2 to Serenity/JS 3 with our comprehensive guide.
100100

101101
## Join the Serenity/JS Community!

src/docs/handbook/test-runners/cucumber.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,7 @@ graph TB
7373

7474
### Installing Serenity/JS test runner adapter
7575

76-
Assuming you already have a [Node.js project](/handbook/installation/#creating-a-nodejs-project)
77-
and [Serenity/JS runtime dependencies](/handbook/installation/) set up,
76+
Assuming you already have a Node.js project and [Serenity/JS runtime dependencies](/handbook/installation/) set up,
7877
add the following Node modules:
7978
- [`@serenity-js/core`](/api/core)
8079
- [`@serenity-js/cucumber`](/api/cucumber)

src/docs/handbook/test-runners/jasmine.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ graph TB
7272

7373
### Installing Serenity/JS test runner adapter
7474

75-
Assuming you already have a [Node.js project](/handbook/installation/#creating-a-nodejs-project)
76-
and [Serenity/JS runtime dependencies](/handbook/installation/) set up,
75+
Assuming you already have a Node.js project and [Serenity/JS runtime dependencies](/handbook/installation/) set up,
7776
add the following Node modules:
7877
- [`@serenity-js/core`](/api/core)
7978
- [`@serenity-js/jasmine`](/api/jasmine)

src/docs/handbook/test-runners/mocha.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ graph TB
7171

7272
### Installing Serenity/JS test runner adapter
7373

74-
Assuming you already have a [Node.js project](/handbook/installation/#creating-a-nodejs-project)
75-
and [Serenity/JS runtime dependencies](/handbook/installation/) set up,
74+
Assuming you already have a Node.js project and [Serenity/JS runtime dependencies](/handbook/installation/) set up,
7675
add the following Node modules:
7776
- [`@serenity-js/core`](/api/core)
7877
- [`@serenity-js/mocha`](/api/mocha)

src/docs/handbook/test-runners/protractor.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ The most commonly used Screenplay Pattern APIs come from the following modules:
305305
A test scenario following the Screenplay Pattern models workflows of one or multiple [actors](/api/core/class/Actor/) representing people and external systems interacting with the system under test.
306306

307307
When you configure [Serenity/JS Protractor](/api/protractor)
308-
as the [Protractor `framework`](/handbook/test-runners/protractor#configuring-serenityjs),
308+
as the [Protractor `framework`](#integrating-serenityjs-reporting),
309309
Serenity/JS automatically creates and makes available a default [cast](/api/core/class/Cast) of [actors](/api/core/class/Actor/),
310310
where every actor has the abilities to:
311311
- [`BrowseTheWebWithProtractor`](/api/protractor/class/BrowseTheWebWithProtractor/) - Allows interaction with the browser using the global `protractor.browser` object.

src/docs/handbook/test-runners/webdriverio.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Learn more:
105105

106106
### Adding Serenity/JS to an existing project
107107

108-
To add Serenity/JS to an existing WebdriverIO project, you'll need to install the required Serenity/JS modules and [configure the WebdriverIO test runner](#configuring-serenityjs) to use Serenity/JS framework and reporting services.
108+
To add Serenity/JS to an existing WebdriverIO project, you'll need to install the required Serenity/JS modules and [configure the WebdriverIO test runner](#configuration) to use Serenity/JS framework and reporting services.
109109

110110
#### Compatibility
111111

@@ -379,7 +379,7 @@ The most commonly used Screenplay Pattern APIs come from the following modules:
379379

380380
A test scenario following the Screenplay Pattern models workflows of one or multiple [actors](/api/core/class/Actor/) representing people and external systems interacting with the system under test.
381381

382-
When you [register `@serenity-js/webdriverio`](#configuring-serenityjs) as your WebdriverIO `framework`, Serenity/JS automatically configures
382+
When you [register `@serenity-js/webdriverio`](#integrating-serenityjs-reporting) as your WebdriverIO `framework`, Serenity/JS automatically configures
383383
a default [cast](/api/core/class/Cast/) of actors where every actor, where every actor has the abilities to:
384384

385385
To do so, Serenity/JS equips your actors with abilities to:
@@ -559,7 +559,7 @@ When your test run finishes, test results will be available in the `target/site/
559559
To view them, open the `index.html` file in your preferred web browser.
560560

561561
:::tip Using WebdriverIO CLI wizard
562-
To avoid naming conflicts with any existing `test` script, projects created using the [WebdriverIO CLI wizard](#using-the-webdriverio-cli-wizard) come pre-configured with a `serenity` script that runs your tests and generates the reports:
562+
To avoid naming conflicts with any existing `test` script, projects created using the [WebdriverIO CLI wizard](#initialising-a-webdriverio-project) come pre-configured with a `serenity` script that runs your tests and generates the reports:
563563

564564
```sh
565565
npm run serenity

src/docs/handbook/tutorials/upgrading-from-serenity-js-2.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ However, if the default configuration is not sufficient to your needs,
112112
every test runner integration still lets you configure a custom cast.
113113

114114
Learn how to configure a custom cast of actors with:
115-
- [Playwright Test](/handbook/test-runners/playwright-test#configuring-a-custom-cast-of-actors)
116-
- [Protractor](/handbook/test-runners/protractor#configuring-a-custom-cast-of-actors)
117-
- [WebdriverIO](/handbook/test-runners/webdriverio/#customising-serenityjs-actors)
115+
- [Playwright Test](/handbook/test-runners/playwright-test/#replacing-the-default-actors)
116+
- [Protractor](/handbook/test-runners/protractor/#replacing-the-default-actors)
117+
- [WebdriverIO](/handbook/test-runners/webdriverio/#replacing-the-default-actors)
118118

119119
### Implementing portable `Interaction`s and `Question`s
120120

src/docs/handbook/tutorials/your-first-web-scenario.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -704,7 +704,7 @@ generated under `target/site/serenity`, and served on port `8080` on Gitpod:
704704
img={require('@site/static/images/web-testing/your-first-web-scenario/vs-code-test-reporting-serenity-bdd.gif')}
705705
/>
706706

707-
[Playwright Test reports](/handbook/test-runners/playwright-test#using-serenityjs-reporting-services) are generated
707+
[Playwright Test reports](/handbook/test-runners/playwright-test/#reporting) are generated
708708
under `playwright-report` and served on port `8181` on Gitpod:
709709

710710
<Figure

0 commit comments

Comments
 (0)