Skip to content

Commit 66de4fd

Browse files
committed
docs(website): updated Serenity BDD installation instructions serenity-js/serenity-js#2560
1 parent 7f23bcf commit 66de4fd

File tree

4 files changed

+254
-194
lines changed

4 files changed

+254
-194
lines changed

src/docs/handbook/getting-started/serenity-js-with-playwright-test.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ To learn more about the Playwright Test Trace Viewer, check out:
168168
They aim not only to **report test results**, but also to document **how features are tested**, and **what your application does**.
169169

170170
Serenity BDD reports are generated by [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-core/tree/main/serenity-cli),
171-
a Java program downloaded and managed by the [`@serenity-js/serenity-bdd`](/api/serenity-bdd/) module.
171+
a Java program provided by the [`@serenity-js/serenity-bdd`](/api/serenity-bdd/) module.
172172

173173
View [live Serenity BDD report on GitHub](https://serenity-js.github.io/serenity-js-playwright-test-template/serenity/) 👀
174174

@@ -179,20 +179,17 @@ View [live Serenity BDD report on GitHub](https://serenity-js.github.io/serenity
179179
/>
180180

181181
To produce Serenity BDD reports, your test suite must:
182-
- download the Serenity BDD CLI, by calling `serenity-bdd update` (which caches the CLI `jar` locally)
183182
- produce intermediate Serenity BDD `.json` reports, by registering [`SerenityBDDReporter`](/api/serenity-bdd/class/SerenityBDDReporter/) as per the [configuration instructions](#configuring-serenityjs)
184183
- invoke the Serenity BDD CLI when you want to produce the report, by calling `serenity-bdd run`
185184

186185
The pattern used by all the [Serenity/JS Project Templates](/handbook/getting-started/project-templates/) relies
187-
on using:
188-
- a [`postinstall`](https://docs.npmjs.com/cli/v9/using-npm/scripts#life-cycle-operation-order) NPM script to download the Serenity BDD CLI
186+
on using the following Node modules:
189187
- [`npm-failsafe`](https://www.npmjs.com/package/npm-failsafe) to run the reporting process even if the test suite itself has failed (which is precisely when you need test reports the most...).
190188
- [`rimraf`](https://www.npmjs.com/package/rimraf) as a convenience method to remove any test reports left over from the previous run
191189

192190
```json title="package.json"
193191
{
194192
"scripts": {
195-
"postinstall": "serenity-bdd update",
196193
"clean": "rimraf target",
197194
"test": "failsafe clean test:execute test:report",
198195
"test:execute": "playwright test",

src/docs/handbook/getting-started/serenity-js-with-protractor.mdx

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -224,26 +224,23 @@ and complete [`protractor.conf.js`](https://github.com/serenity-js/serenity-js-m
224224
## Producing Serenity BDD reports and living documentation
225225

226226
[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),
227-
a Java program downloaded and managed by the [`@serenity-js/serenity-bdd`](/api/serenity-bdd/) module.
227+
a Java program provided by the [`@serenity-js/serenity-bdd`](/api/serenity-bdd/) module.
228228

229229
To produce Serenity BDD reports, your test suite must:
230-
- download the Serenity BDD CLI, by calling `serenity-bdd update` which caches the CLI `jar` locally
231-
- produce intermediate Serenity BDD `.json` reports, by registering [`SerenityBDDReporter`](/api/serenity-bdd/class/SerenityBDDReporter/) as per the [configuration instructions](#configuring-serenityjs-and-protractor)
230+
- produce intermediate Serenity BDD `.json` reports, by registering [`SerenityBDDReporter`](/api/serenity-bdd/class/SerenityBDDReporter/) as per the [configuration instructions](#configuring-serenityjs-and-webdriverio)
232231
- invoke the Serenity BDD CLI when you want to produce the report, by calling `serenity-bdd run`
233232

234233
The pattern used by all the [Serenity/JS Project Templates](/handbook/getting-started/project-templates/) relies
235-
on using:
236-
- a [`postinstall`](https://docs.npmjs.com/cli/v9/using-npm/scripts#life-cycle-operation-order) NPM script to download the Serenity BDD CLI
234+
on using the following Node modules:
237235
- [`npm-failsafe`](https://www.npmjs.com/package/npm-failsafe) to run the reporting process even if the test suite itself has failed (which is precisely when you need test reports the most...).
238236
- [`rimraf`](https://www.npmjs.com/package/rimraf) as a convenience method to remove any test reports left over from the previous run
239237

240238
```json title="package.json"
241239
{
242240
"scripts": {
243-
"postinstall": "serenity-bdd update",
244241
"clean": "rimraf target",
245242
"test": "failsafe clean test:execute test:report",
246-
"test:execute": "protractor ./protractor.conf.js",
243+
"test:execute": "wdio wdio.conf.ts",
247244
"test:report": "serenity-bdd run"
248245
}
249246
}
@@ -582,7 +579,6 @@ Update the `script` section in your `package.json` to use `wdio` instead of `pro
582579
```diff title="package.json"
583580
{
584581
"scripts": {
585-
"postinstall": "serenity-bdd update",
586582
"clean": "rimraf target",
587583
"test": "failsafe clean test:execute test:report",
588584
- "test:execute": "protractor ./protractor.conf.js",

src/docs/handbook/getting-started/serenity-js-with-webdriverio.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,23 +172,20 @@ Learn more about:
172172
## Producing Serenity BDD reports and living documentation
173173

174174
[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),
175-
a Java program downloaded and managed by the [`@serenity-js/serenity-bdd`](/api/serenity-bdd/) module.
175+
a Java program provided by the [`@serenity-js/serenity-bdd`](/api/serenity-bdd/) module.
176176

177177
To produce Serenity BDD reports, your test suite must:
178-
- download the Serenity BDD CLI, by calling `serenity-bdd update` which caches the CLI `jar` locally
179178
- produce intermediate Serenity BDD `.json` reports, by registering [`SerenityBDDReporter`](/api/serenity-bdd/class/SerenityBDDReporter/) as per the [configuration instructions](#configuring-serenityjs-and-webdriverio)
180179
- invoke the Serenity BDD CLI when you want to produce the report, by calling `serenity-bdd run`
181180

182181
The pattern used by all the [Serenity/JS Project Templates](/handbook/getting-started/project-templates/) relies
183-
on using:
184-
- a [`postinstall`](https://docs.npmjs.com/cli/v9/using-npm/scripts#life-cycle-operation-order) NPM script to download the Serenity BDD CLI
182+
on using the following Node modules:
185183
- [`npm-failsafe`](https://www.npmjs.com/package/npm-failsafe) to run the reporting process even if the test suite itself has failed (which is precisely when you need test reports the most...).
186184
- [`rimraf`](https://www.npmjs.com/package/rimraf) as a convenience method to remove any test reports left over from the previous run
187185

188186
```json title="package.json"
189187
{
190188
"scripts": {
191-
"postinstall": "serenity-bdd update",
192189
"clean": "rimraf target",
193190
"test": "failsafe clean test:execute test:report",
194191
"test:execute": "wdio wdio.conf.ts",

0 commit comments

Comments
 (0)