webship-js 2.0.11 → 2.0.13
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.
- package/.circleci/config.yml +10 -1
- package/.drone.yml +7 -7
- package/.github/workflows/github-actions.yml +48 -0
- package/.gitlab-ci.yml +9 -4
- package/.harness/webship-js-pipeline.yml +5 -6
- package/.semaphore/semaphore.yml +6 -9
- package/.teamcity/settings.kts +7 -6
- package/.travis.yml +6 -1
- package/AGENTS.md +1 -1
- package/CLAUDE.md +65 -23
- package/Jenkinsfile +5 -3
- package/azure-pipelines.yml +17 -8
- package/bamboo-specs/bamboo.yml +9 -15
- package/bin/init-webship.js +53 -10
- package/bitbucket-pipelines.yml +5 -1
- package/buildspec.yml +6 -7
- package/cloudbuild.yaml +28 -12
- package/codefresh.yml +6 -6
- package/cucumber.js +17 -10
- package/docs/00-quick-start.md +8 -0
- package/docs/02-bbr-smart-waits.md +15 -10
- package/docs/03-selector-registry.md +24 -0
- package/docs/04-step-reference.md +51 -25
- package/docs/05-web-first-assertions.md +6 -0
- package/docs/07-auth-state.md +1 -1
- package/docs/08-clock-mocking.md +21 -2
- package/docs/09-api-testing.md +40 -2
- package/docs/10-accessibility.md +2 -0
- package/docs/11-debugging.md +3 -1
- package/docs/12-ai-agent-guide.md +5 -0
- package/docs/13-faq.md +72 -1
- package/docs/14-recipes-cookbook.md +2 -0
- package/docs/15-tag-conventions.md +2 -1
- package/docs/16-ci-cd.md +140 -119
- package/docs/README.md +5 -5
- package/docs/advanced-screenshots.md +3 -1
- package/docs/api-step-definitions.md +16 -2
- package/docs/global-settings.md +69 -17
- package/docs/install-webship-js.md +2 -0
- package/docs/step-definitions/then-i-should-see.md +14 -1
- package/docs/step-definitions/then-item-checkbox.md +2 -0
- package/docs/step-definitions/when-i-fill.md +4 -0
- package/docs/step-definitions/when-i-select-option-select-list.md +2 -0
- package/examples/check-switch.html +37 -0
- package/examples/choice-controls.html +29 -0
- package/examples/click-whitespace.html +37 -0
- package/examples/datetime-fields.html +52 -0
- package/examples/element-selector-hint.html +16 -0
- package/examples/field-states.html +27 -0
- package/examples/fill-in-empty.html +26 -0
- package/examples/fill-unreachable.html +27 -0
- package/examples/follow-hidden-first.html +29 -0
- package/examples/iframe-inner.html +20 -0
- package/examples/iframe-nested.html +16 -0
- package/examples/iframe-outer.html +15 -0
- package/examples/multi-value-fields.html +54 -0
- package/examples/registered-names.html +15 -0
- package/examples/select-by-label.html +33 -0
- package/examples/settle-budget.html +21 -0
- package/examples/sorted-tables.html +38 -0
- package/examples/text-matching.html +48 -0
- package/examples/text-order.html +25 -0
- package/examples/touch.html +22 -0
- package/examples/viewport-top.html +36 -0
- package/package.json +17 -1
- package/playwright.config.ts +3 -1
- package/tests/check-api-launch-url.js +106 -0
- package/tests/check-assets.js +103 -0
- package/tests/check-attachments.js +105 -0
- package/tests/check-breakpoints.js +117 -0
- package/tests/check-clock.js +143 -0
- package/tests/check-config.js +90 -0
- package/tests/check-context.js +215 -0
- package/tests/check-dry-run.js +104 -0
- package/tests/check-examples.js +10 -4
- package/tests/check-exit-report.js +141 -0
- package/tests/check-javascript-errors.js +105 -0
- package/tests/check-must-fail.js +5 -4
- package/tests/check-network-changed.js +137 -0
- package/tests/check-scaffold.js +54 -2
- package/tests/check-screenshots.js +117 -0
- package/tests/check-settle-verbs.js +137 -0
- package/tests/check-time-limit.js +104 -0
- package/tests/check-video.js +156 -0
- package/tests/check-world.js +167 -0
- package/tests/features/api-base-url.feature +25 -0
- package/tests/features/api-form-data.feature +18 -0
- package/tests/features/api-json-paths.feature +24 -0
- package/tests/features/api-response-contains.feature +21 -0
- package/tests/features/api-response-header-presence.feature +17 -0
- package/tests/features/api-response-header.feature +17 -0
- package/tests/features/api-saved-placeholders.feature +37 -0
- package/tests/features/api-step-definitions-individual.feature +1 -1
- package/tests/features/api-tables.feature +40 -0
- package/tests/features/breakpoints.feature +25 -0
- package/tests/features/check-switch.feature +28 -0
- package/tests/features/choice-controls.feature +35 -0
- package/tests/features/click-whitespace.feature +29 -0
- package/tests/features/complete-api-testing-examples.feature +1 -1
- package/tests/features/datetime-field-lookup.feature +29 -0
- package/tests/features/element-selector-hint.feature +14 -0
- package/tests/features/field-state.feature +21 -0
- package/tests/features/fill-in-empty-value.feature +41 -0
- package/tests/features/fill-reachable.feature +13 -0
- package/tests/features/follow-hidden-first.feature +9 -0
- package/tests/features/iframe-nested.feature +43 -0
- package/tests/features/javascript-tolerated-errors.feature +20 -0
- package/tests/features/modal-open.feature +13 -0
- package/tests/features/multi-value-field-lookup.feature +30 -0
- package/tests/features/registered-names.feature +14 -0
- package/tests/features/select-by-label.feature +31 -0
- package/tests/features/selector-files.feature +14 -0
- package/tests/features/selectors-table-header.feature +35 -0
- package/tests/features/settle-budget.feature +11 -0
- package/tests/features/sorted-tables.feature +19 -0
- package/tests/features/storage-quoted-values.feature +26 -0
- package/tests/features/text-matching.feature +38 -0
- package/tests/features/text-order.feature +14 -0
- package/tests/features/touch.feature +21 -0
- package/tests/features/viewport-top.feature +13 -0
- package/tests/features/xml-namespaces.feature +34 -0
- package/tests/must-fail/api-json-paths.feature +21 -0
- package/tests/must-fail/api-response-contains.feature +23 -0
- package/tests/must-fail/api-response-header-presence.feature +17 -0
- package/tests/must-fail/api-response-header.feature +21 -0
- package/tests/must-fail/api-without-base-url.feature +11 -0
- package/tests/must-fail/breakpoints.feature +15 -0
- package/tests/must-fail/choice-controls.feature +25 -0
- package/tests/must-fail/clock.feature +11 -0
- package/tests/must-fail/datetime-field.feature +10 -0
- package/tests/must-fail/element-selector-hint.feature +17 -0
- package/tests/must-fail/field-state.feature +20 -0
- package/tests/must-fail/fill-field.feature +30 -0
- package/tests/must-fail/iframe-text.feature +17 -0
- package/tests/must-fail/modal-open.feature +26 -0
- package/tests/must-fail/multi-value-field.feature +18 -0
- package/tests/must-fail/registered-names.feature +25 -0
- package/tests/must-fail/select-list.feature +15 -0
- package/tests/must-fail/selector-files.feature +10 -0
- package/tests/must-fail/sorted-tables.feature +20 -0
- package/tests/must-fail/storage-before-a-page.feature +13 -0
- package/tests/must-fail/text-matching.feature +16 -0
- package/tests/must-fail/text-order.feature +15 -0
- package/tests/must-fail/viewport-top.feature +20 -0
- package/tests/must-fail/yaml-numbers.feature +48 -0
- package/tests/step-definitions/a11y.steps.js +24 -15
- package/tests/step-definitions/action.steps.js +53 -20
- package/tests/step-definitions/api.steps.js +349 -67
- package/tests/step-definitions/assertion.steps.js +100 -10
- package/tests/step-definitions/auth.steps.js +15 -18
- package/tests/step-definitions/clock.steps.js +22 -0
- package/tests/step-definitions/debug.steps.js +8 -0
- package/tests/step-definitions/dialog.steps.js +7 -0
- package/tests/step-definitions/element.steps.js +132 -17
- package/tests/step-definitions/field.steps.js +412 -96
- package/tests/step-definitions/form.steps.js +88 -37
- package/tests/step-definitions/iframe.steps.js +89 -29
- package/tests/step-definitions/input.steps.js +26 -7
- package/tests/step-definitions/javascript.steps.js +64 -22
- package/tests/step-definitions/modal.steps.js +79 -13
- package/tests/step-definitions/navigation.steps.js +14 -0
- package/tests/step-definitions/network.steps.js +15 -5
- package/tests/step-definitions/response.steps.js +6 -4
- package/tests/step-definitions/responsive.steps.js +26 -33
- package/tests/step-definitions/screenshot.steps.js +25 -8
- package/tests/step-definitions/scroll.steps.js +20 -0
- package/tests/step-definitions/selectors.steps.js +95 -48
- package/tests/step-definitions/storage.steps.js +38 -13
- package/tests/step-definitions/table.steps.js +81 -6
- package/tests/step-definitions/video.steps.js +52 -55
- package/tests/step-definitions/wait.steps.js +88 -23
- package/tests/step-definitions/web-first.steps.js +69 -35
- package/tests/step-definitions/webship.js +741 -145
- package/tests/step-definitions/xml.steps.js +49 -15
- package/tests/step-definitions/yaml.steps.js +45 -20
package/docs/16-ci-cd.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
# CI / CD setup
|
|
2
2
|
|
|
3
|
-
Webship-js ships ready-to-use config files for every major CI/CD provider. The pattern is the same everywhere:
|
|
3
|
+
Webship-js ships ready-to-use config files for every major CI/CD provider. The pattern is the same everywhere: Node 24 (or the Node of the official Playwright image), install Playwright's chromium with its system deps, start the fixture server on port 8080, run `npm test`, and keep `tests/reports/`, `screenshots/` and `videos/` as artifacts of the run, passed or failed, wherever the provider keeps artifacts. No build step — `tsx` transpiles `.ts` step files on the fly.
|
|
4
|
+
|
|
5
|
+
The configs that run in the official Playwright image (Jenkins, Google Cloud Build, TeamCity, Drone, Bamboo, Codefresh) use the image of the Playwright version a fresh `npm install` brings, `mcr.microsoft.com/playwright:v1.65.1-noble` today, and still run `npx playwright install --with-deps chromium`: when a newer Playwright gets installed, its browser is downloaded, and moving the image tag to that version skips the download again.
|
|
6
|
+
|
|
7
|
+
Prices, free minutes, credits and plan names change without notice, so this page and the config comments do not quote them: each provider's own pricing page has the current ones.
|
|
4
8
|
|
|
5
9
|
## Supported providers
|
|
6
10
|
|
|
@@ -24,7 +28,7 @@ Webship-js ships ready-to-use config files for every major CI/CD provider. The p
|
|
|
24
28
|
| Bamboo Data Center | `bamboo-specs/bamboo.yml` | self-hosted (Atlassian) | yes |
|
|
25
29
|
| Codefresh | `codefresh.yml` | codefresh.io | yes |
|
|
26
30
|
| Octopus Deploy | (no test runner — CD only, see notes) | octopus.com | n/a |
|
|
27
|
-
| ~~Codeship~~ | retired
|
|
31
|
+
| ~~Codeship~~ | retired — do not use | — | — |
|
|
28
32
|
|
|
29
33
|
Each provider's setup notes live in its own section below.
|
|
30
34
|
|
|
@@ -34,7 +38,7 @@ Each provider's setup notes live in its own section below.
|
|
|
34
38
|
|
|
35
39
|
**File**: `.github/workflows/github-actions.yml`.
|
|
36
40
|
|
|
37
|
-
GitHub's native CI/CD.
|
|
41
|
+
GitHub's native CI/CD.
|
|
38
42
|
|
|
39
43
|
### Setup steps — open account + connect repo
|
|
40
44
|
|
|
@@ -54,14 +58,29 @@ Single job `build` on `ubuntu-latest`, 45-minute limit:
|
|
|
54
58
|
3. `npm install`.
|
|
55
59
|
4. `npm run test:report` — generates an HTML report from a small JSON and checks it: no third-party icon, the project's own version, the place of execution.
|
|
56
60
|
5. `npx playwright install --with-deps chromium`.
|
|
57
|
-
6. `npm run test:
|
|
58
|
-
7. `npm run test:
|
|
59
|
-
8. `npm
|
|
60
|
-
9.
|
|
61
|
-
10. `npm run test:
|
|
62
|
-
11. `npm test
|
|
63
|
-
12. `npm run test:
|
|
64
|
-
13. `
|
|
61
|
+
6. `npm run test:dry-run` — no server: a dry run with the pretty formatter prints the steps, `? undefined` and the summary with no `- skipped` line for each hook or step; a real run still shows a skipped step.
|
|
62
|
+
7. `npm run test:api-launch-url` — no server: a relative API base URL follows `worldParameters.launchUrl`, and a scenario without a base URL fails plainly instead of reusing the previous one.
|
|
63
|
+
8. `npm run test:examples` — no browser: every step definition is documented with at least five examples that use it, every example step and every feature step resolves to exactly one definition.
|
|
64
|
+
9. `npm run test:time-limit` — no server: under a short `WEBSHIP_STEP_TIMEOUT`, the waits that take a length and the web-first `within N seconds` matchers run past the step timeout and pass, or fail with their own message.
|
|
65
|
+
10. `npm run test:paths` — no browser: a feature or a scenario (`file:line`) named on the command line runs alone, and naming none runs the whole suite (dry runs).
|
|
66
|
+
11. `npm run test:attachments` — the print steps (accessibility violations, …) attach what they print to the step in the JSON report.
|
|
67
|
+
12. `npm run test:js-errors` — no server: with warnings captured, the errors check counts errors only and the warnings check warnings only; what a check did not read is reported at the end of the scenario, in warn and in fail mode.
|
|
68
|
+
13. `npm run test:screenshots` — runs a skipped, a pending and a failing scenario and checks that only the failing one leaves a failure screenshot.
|
|
69
|
+
14. `npm run test:assets` — no server: in a project of its own, the attach, XML-file and YAML-file steps read its `tests/assets/` and paths from its root, and a missing file fails plainly.
|
|
70
|
+
15. `npm run test:config` — runs a scenario with a `cucumber.js` whose `worldParameters` carry only the launch URL, and checks that it passes and that the run ends by itself.
|
|
71
|
+
16. `npm run test:exit-report` — no server: the HTML report built at the end of a run is built once with `--parallel`, from a JSON report written elsewhere, and says so in one line when there is none.
|
|
72
|
+
17. `npm run test:breakpoints` — the `@mobile` / `@desktop` tags and the two named-viewport steps open at the sizes of one registry: the config, `WEBSHIP_SELECTORS_BREAKPOINTS`, the breakpoint marked `default: true` and the names a scenario adds.
|
|
73
|
+
18. `npm run test:context` — runs scenarios that restore an auth state and start and stop a video recording, and checks that the new page keeps the viewport of the `@mobile` tag, the smart waits, the cookies, JavaScript-error capture and the request log (it serves its own page).
|
|
74
|
+
19. `npm run test:video` — runs recorded scenarios in the `on`, `on-failure` and `off` modes and checks the video folder: final names with the status in lower case, no temporary `page@….webm` left, `print video path` printing the saved path, a reserved name kept on failure, a stopped recording named by the pattern, `WEBSHIP_VIDEO_SIZE` read.
|
|
75
|
+
20. `npm run test:world` — runs a project World that extends `PlaywrightWorld` with a project step ending in `this.smartSettle()`, then a World that replaces it, and checks the first keeps the `@mobile` viewport and the settle and the second is reported (it serves its own page).
|
|
76
|
+
21. `npm run test:clock` — installs a fake clock and checks that a navigation and a press still settle as soon as the page is quiet, and that advancing a clock nobody installed prints a note (it serves its own page).
|
|
77
|
+
22. `npm run test:settle-verbs` — runs a project's own steps whose words carry a page-changing verb (add, log out, enter, open, delete, save) and checks that the settle after each one waited for the page; `wait for ajax to finish` in lower case is a step (it serves its own page).
|
|
78
|
+
23. `npm start &` — backgrounds the fixture server.
|
|
79
|
+
24. Waits until the server answers on port 8080 (30 seconds at most).
|
|
80
|
+
25. `npm run test:must-fail` — runs the scenarios of `tests/must-fail/`, which must fail, and checks that each fails at its last step with the message it announces, the address of the page and a hint.
|
|
81
|
+
26. `npm test`.
|
|
82
|
+
27. `npm run test:scaffold` — scaffolds a new project, runs its first `npm test` and one feature named on the command line (see the notes below).
|
|
83
|
+
28. `actions/upload-artifact@v7` — uploads the report, screenshots and videos, on success and on failure.
|
|
65
84
|
|
|
66
85
|
`FORCE_COLOR=1` is set on the job so cucumber-js v10 emits ANSI colours.
|
|
67
86
|
|
|
@@ -111,7 +130,7 @@ For a PDF next to the HTML report, add `npx generate-reports --format pdf` as a
|
|
|
111
130
|
|
|
112
131
|
**File**: `.gitlab-ci.yml`.
|
|
113
132
|
|
|
114
|
-
GitLab's first-party CI/CD
|
|
133
|
+
GitLab's first-party CI/CD, on GitLab.com's shared runners or on runners of your own.
|
|
115
134
|
|
|
116
135
|
### Setup steps — open account + connect repo
|
|
117
136
|
|
|
@@ -123,12 +142,13 @@ GitLab's first-party CI/CD. #3 by adoption (~19%). Free tier on GitLab.com: 400
|
|
|
123
142
|
|
|
124
143
|
### Pipeline contents
|
|
125
144
|
|
|
126
|
-
Single job `test` running on the `node:
|
|
145
|
+
Single job `webship-js-test` running on the `node:24` image:
|
|
127
146
|
|
|
128
147
|
1. `npm install`.
|
|
129
|
-
2. `npx playwright install --with-deps chromium
|
|
148
|
+
2. `npx playwright install --with-deps chromium` (installs the system libraries Chromium needs, nothing else).
|
|
130
149
|
3. `npm start &` + `sleep 3`.
|
|
131
150
|
4. `npm test`.
|
|
151
|
+
5. Keeps `tests/reports/`, `screenshots/` and `videos/` as the `cucumber-report` artifact for 14 days, passed or failed.
|
|
132
152
|
|
|
133
153
|
`FORCE_COLOR: "1"` is set in the job's `variables:` block.
|
|
134
154
|
|
|
@@ -144,27 +164,24 @@ The `job=` query param targets a specific job's status; drop it to show the whol
|
|
|
144
164
|
|
|
145
165
|
### Reports
|
|
146
166
|
|
|
147
|
-
|
|
167
|
+
The job keeps its report, passed or failed:
|
|
148
168
|
|
|
149
169
|
```yaml
|
|
150
|
-
test:
|
|
151
170
|
artifacts:
|
|
171
|
+
name: cucumber-report
|
|
152
172
|
when: always
|
|
153
|
-
expire_in:
|
|
173
|
+
expire_in: 14 days
|
|
154
174
|
paths:
|
|
155
|
-
- tests/reports/
|
|
156
|
-
- tests/reports/cucumber_report.pdf
|
|
157
|
-
- tests/reports/cucumber_report.json
|
|
175
|
+
- tests/reports/
|
|
158
176
|
- screenshots/
|
|
159
|
-
|
|
160
|
-
junit: tests/reports/junit.xml # if you add --format junit:
|
|
177
|
+
- videos/
|
|
161
178
|
```
|
|
162
179
|
|
|
163
|
-
|
|
180
|
+
Download it from the job page. For test results on the merge-request page, add `reports: junit: tests/reports/junit.xml` to the block and a `--format junit:tests/reports/junit.xml` formatter to the run.
|
|
164
181
|
|
|
165
182
|
### Notes
|
|
166
183
|
|
|
167
|
-
- The `node:
|
|
184
|
+
- The `node:24` Docker image carries no browser: `--with-deps` installs Chromium and its system libraries on each run. Use `cache:` keyed on a lockfile to skip the npm part on reruns.
|
|
168
185
|
- Merge-request pipelines (`workflow.rules`) trigger by default; add `rules:` to scope to specific branches.
|
|
169
186
|
- For self-hosted runners on macOS / Windows, set `tags:` on the job and on the runner registration so the right runner picks up the work.
|
|
170
187
|
- Per-browser matrix: use `parallel.matrix` with `BROWSER: [chromium, firefox, webkit]`.
|
|
@@ -175,7 +192,7 @@ GitLab renders JUnit XML inline on the merge-request page.
|
|
|
175
192
|
|
|
176
193
|
**File**: `bitbucket-pipelines.yml`.
|
|
177
194
|
|
|
178
|
-
Atlassian Bitbucket's native CI/CD
|
|
195
|
+
Atlassian Bitbucket's native CI/CD, linked tightly to Jira / Confluence / Trello, so handy in Atlassian-stack shops.
|
|
179
196
|
|
|
180
197
|
### Setup steps — open account + connect repo
|
|
181
198
|
|
|
@@ -183,27 +200,34 @@ Atlassian Bitbucket's native CI/CD. Free tier: 50 build-minutes per month for pr
|
|
|
183
200
|
2. **Create a workspace** (e.g. `webshipco`). Required — every repo lives inside a workspace.
|
|
184
201
|
3. **Create or import the repo**. Bitbucket can import from GitHub directly.
|
|
185
202
|
4. **Enable Pipelines**: `repo → Repository settings → Pipelines → Settings → Enable Pipelines`. Toggle is off by default until you read & accept the runner terms.
|
|
186
|
-
5. **(Optional) Self-hosted runners**: `Repository settings → Pipelines → Runners → Add runner`.
|
|
203
|
+
5. **(Optional) Self-hosted runners**: `Repository settings → Pipelines → Runners → Add runner`.
|
|
187
204
|
|
|
188
205
|
### Pipeline contents
|
|
189
206
|
|
|
190
207
|
`bitbucket-pipelines.yml` defines a single default pipeline:
|
|
191
208
|
|
|
192
209
|
```yaml
|
|
193
|
-
image: node:
|
|
210
|
+
image: node:24
|
|
211
|
+
|
|
194
212
|
pipelines:
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
213
|
+
default:
|
|
214
|
+
- step:
|
|
215
|
+
name: Install and Test
|
|
216
|
+
caches:
|
|
217
|
+
- node
|
|
218
|
+
script:
|
|
219
|
+
- npm install
|
|
220
|
+
- npx playwright install --with-deps chromium
|
|
221
|
+
- npm start &
|
|
222
|
+
- sleep 3
|
|
223
|
+
- FORCE_COLOR=1 npm test
|
|
224
|
+
artifacts:
|
|
225
|
+
- tests/reports/**
|
|
226
|
+
- screenshots/**
|
|
227
|
+
- videos/**
|
|
204
228
|
```
|
|
205
229
|
|
|
206
|
-
`FORCE_COLOR=1` is set
|
|
230
|
+
`FORCE_COLOR=1` is set on the `npm test` line.
|
|
207
231
|
|
|
208
232
|
### Badge
|
|
209
233
|
|
|
@@ -217,25 +241,12 @@ Uses shields.io as a proxy because Bitbucket does not expose a native SVG endpoi
|
|
|
217
241
|
|
|
218
242
|
### Reports
|
|
219
243
|
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
```yaml
|
|
223
|
-
- step:
|
|
224
|
-
name: test
|
|
225
|
-
script: [ npm test ]
|
|
226
|
-
artifacts:
|
|
227
|
-
- tests/reports/cucumber_report.html
|
|
228
|
-
- tests/reports/cucumber_report.pdf
|
|
229
|
-
- tests/reports/cucumber_report.json
|
|
230
|
-
- screenshots/**
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
Artefacts live for 14 days on the free tier, 30 days on paid plans. Download from the build page.
|
|
244
|
+
The step's `artifacts:` keep `tests/reports/`, `screenshots/` and `videos/`; Bitbucket captures artifacts whether the step passed or failed. Download them from the build page; how long they are kept depends on the plan (see the Bitbucket docs).
|
|
234
245
|
|
|
235
246
|
### Notes
|
|
236
247
|
|
|
237
|
-
-
|
|
238
|
-
- `pipelines.
|
|
248
|
+
- `size: 2x` on the step gives it twice the memory and CPU, for a slower site or a bigger suite.
|
|
249
|
+
- `pipelines.default` runs on every branch; use `pipelines.branches.<name>` to scope it, and `pull-requests:` for PR builds.
|
|
239
250
|
- Atlassian's Pipes (`pipe:`) catalogue covers Slack notifications, AWS deploys, Jira issue transitions, etc. — drop them into the `script:` section as named steps.
|
|
240
251
|
- Per-browser matrix: define three steps under `parallel:` with `BROWSER` env variations.
|
|
241
252
|
|
|
@@ -245,24 +256,25 @@ Artefacts live for 14 days on the free tier, 30 days on paid plans. Download fro
|
|
|
245
256
|
|
|
246
257
|
**File**: `.circleci/config.yml`.
|
|
247
258
|
|
|
248
|
-
|
|
259
|
+
Hosted CI with Docker executors and a long-standing open-source following.
|
|
249
260
|
|
|
250
261
|
### Setup steps — open account + connect repo
|
|
251
262
|
|
|
252
263
|
1. **Sign up**: <https://circleci.com/signup/> → "Sign Up with GitHub" → authorise the CircleCI GitHub App on `webship/webship-js`.
|
|
253
264
|
2. **Choose an organisation** (your GitHub org / user). CircleCI mirrors the GitHub permissions model.
|
|
254
265
|
3. **Set up the project**: dashboard → `Projects → Set up project` → pick `webship-js` → "Use the .circleci/config.yml in my repo" → branch `2.0.x`.
|
|
255
|
-
4. **Pick a plan**:
|
|
266
|
+
4. **Pick a plan**: see CircleCI's pricing page for what the free plan covers today.
|
|
256
267
|
|
|
257
268
|
### Pipeline contents
|
|
258
269
|
|
|
259
|
-
`.circleci/config.yml` uses the `cimg/node:
|
|
270
|
+
`.circleci/config.yml` uses the `cimg/node:24` Docker executor (Node 24 + npm preinstalled, the newest 24.x). Steps:
|
|
260
271
|
|
|
261
272
|
1. `checkout`.
|
|
262
273
|
2. `npm install`.
|
|
263
274
|
3. `npx playwright install --with-deps chromium`.
|
|
264
275
|
4. `npm start &` + `sleep 3`.
|
|
265
276
|
5. `npm test`.
|
|
277
|
+
6. `store_artifacts` for `tests/reports`, `screenshots` and `videos`.
|
|
266
278
|
|
|
267
279
|
`FORCE_COLOR: "1"` is exported in the job environment. Filter `branches.only: /^2.0.x/` keeps feature-branch pushes off the queue.
|
|
268
280
|
|
|
@@ -278,7 +290,7 @@ Already shipped in `README.md`:
|
|
|
278
290
|
|
|
279
291
|
### Reports + screenshots
|
|
280
292
|
|
|
281
|
-
|
|
293
|
+
The job ends with three `store_artifacts` steps:
|
|
282
294
|
|
|
283
295
|
```yaml
|
|
284
296
|
- store_artifacts:
|
|
@@ -286,26 +298,40 @@ Add `store_artifacts` to the test step:
|
|
|
286
298
|
destination: cucumber-report
|
|
287
299
|
- store_artifacts:
|
|
288
300
|
path: screenshots
|
|
289
|
-
destination:
|
|
290
|
-
|
|
301
|
+
destination: screenshots
|
|
302
|
+
- store_artifacts:
|
|
303
|
+
path: videos
|
|
304
|
+
destination: videos
|
|
291
305
|
```
|
|
292
306
|
|
|
293
|
-
|
|
307
|
+
`store_artifacts` runs even when an earlier step failed, so a failed run keeps its report too. The files are links on the job's Artifacts tab.
|
|
294
308
|
|
|
295
309
|
### Notes
|
|
296
310
|
|
|
297
|
-
- `cimg/node:
|
|
311
|
+
- `cimg/node:24` is CircleCI's "convenience image" for the newest Node 24.x; pin a minor (`cimg/node:24.22`) for repeatable runs.
|
|
298
312
|
- The earlier config used `cimg/base:stable-20.04` with manual `apt upgrade` and a NodeSource curl-pipe. That path hit 200-package apt upgrades and PPA 503s (issue #280) and was replaced with the slim form documented above.
|
|
299
|
-
- Docker layer caching is
|
|
313
|
+
- Docker layer caching is a paid feature — toggle it in the executor block with `docker_layer_caching: true` on a plan that has it.
|
|
300
314
|
- Per-browser matrix: use a `matrix` block under `jobs:` or duplicate the job per browser.
|
|
301
315
|
|
|
302
316
|
---
|
|
303
317
|
|
|
318
|
+
## Travis CI
|
|
319
|
+
|
|
320
|
+
**File**: `.travis.yml`.
|
|
321
|
+
|
|
322
|
+
Hosted CI on travis-ci.com. The shipped file runs Node 24 on Ubuntu 22.04 (`dist: jammy`) for the `2.0.x` branch and its tags: it caches npm and `~/.cache/ms-playwright`, installs Chromium with `--with-deps`, starts the fixture server, checks that it answers and runs `npm test`.
|
|
323
|
+
|
|
324
|
+
### Reports
|
|
325
|
+
|
|
326
|
+
Travis CI keeps no build artifacts of its own: the report, the screenshots and the videos (`tests/reports/`, `screenshots/`, `videos/`) stay on the build machine and are lost with it. To keep them, upload them to storage of your own in an `after_script` step (an S3 bucket, for example), or run the suite on another provider of this page.
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
304
330
|
## Jenkins
|
|
305
331
|
|
|
306
332
|
**File**: `Jenkinsfile` (declarative pipeline, at repo root).
|
|
307
333
|
|
|
308
|
-
Jenkins has no SaaS — you run a controller yourself. The shipped `Jenkinsfile` uses the official `mcr.microsoft.com/playwright:v1.
|
|
334
|
+
Jenkins has no SaaS — you run a controller yourself. The shipped `Jenkinsfile` uses the official `mcr.microsoft.com/playwright:v1.65.1-noble` Docker image, of the Playwright version the install brings, so chromium and every apt dependency are already inside.
|
|
309
335
|
|
|
310
336
|
### Setup steps
|
|
311
337
|
|
|
@@ -329,7 +355,7 @@ Jenkins has no SaaS — you run a controller yourself. The shipped `Jenkinsfile`
|
|
|
329
355
|
|
|
330
356
|
### Reports + screenshots
|
|
331
357
|
|
|
332
|
-
The `post { always }` block archives `tests/reports
|
|
358
|
+
The `post { always }` block archives `tests/reports/**`, `screenshots/**` and `videos/**`, passed or failed. Browse them per build in the Jenkins UI under "Build Artifacts".
|
|
333
359
|
|
|
334
360
|
### Badge
|
|
335
361
|
|
|
@@ -338,7 +364,7 @@ Jenkins has no public badge endpoint by default — the controller is usually pr
|
|
|
338
364
|
### Notes
|
|
339
365
|
|
|
340
366
|
- `args '-u root:root'` runs the container as root so `npm install` and `npx playwright install --with-deps` can touch system paths. Switch to a non-root image if you tighten security.
|
|
341
|
-
- The Playwright
|
|
367
|
+
- The Playwright image already has the browser of its own Playwright version and every browser dep: `npx playwright install --with-deps chromium` is a no-op while the installed Playwright matches the image, and downloads the newer browser when it does not.
|
|
342
368
|
- Need parallelism? Wrap the `Test` stage in `parallel { stage('chromium') {...}; stage('firefox') {...} }` and switch the image to `mcr.microsoft.com/playwright` (latest) which includes all three browsers.
|
|
343
369
|
|
|
344
370
|
---
|
|
@@ -347,19 +373,16 @@ Jenkins has no public badge endpoint by default — the controller is usually pr
|
|
|
347
373
|
|
|
348
374
|
**File**: `azure-pipelines.yml` at repo root.
|
|
349
375
|
|
|
350
|
-
Microsoft's hosted CI
|
|
376
|
+
Microsoft's hosted CI. Microsoft-hosted `ubuntu-latest` agents already have Node + most browser deps; the pipeline installs Node 24 (`NodeTool@0`) and still calls `--with-deps` for safety.
|
|
351
377
|
|
|
352
378
|
### Setup steps — open account + connect repo
|
|
353
379
|
|
|
354
380
|
1. **Microsoft account**: if you do not already have one, create at <https://account.microsoft.com/>. Free.
|
|
355
381
|
2. **Sign in to Azure DevOps**: <https://dev.azure.com> → "Start free with GitHub" *or* sign in with the Microsoft account.
|
|
356
382
|
3. **Create an Organization**. Pick a unique slug (used in the URL `https://dev.azure.com/<org>/`). Example: `webship`.
|
|
357
|
-
4. **Create a Project**. Name `webship-js`.
|
|
358
|
-
- **Public** for open source — unlocks the free OSS tier (10 parallel jobs, unlimited minutes).
|
|
359
|
-
- **Private** otherwise (1 free parallel job, 1,800 min/mo).
|
|
383
|
+
4. **Create a Project**. Name `webship-js`. The free parallel jobs and minutes depend on the visibility and on Microsoft's current terms: see the Azure DevOps "parallel jobs" page.
|
|
360
384
|
5. **Pipelines → Create Pipeline → GitHub**. Authorise the **Azure Pipelines** GitHub app, scope it to `webship/webship-js`.
|
|
361
385
|
6. **Configure your pipeline**: choose **"Existing Azure Pipelines YAML file"** → branch `2.0.x` → path `/azure-pipelines.yml` → **Continue → Run**.
|
|
362
|
-
7. **Request OSS free parallelism** (only for public projects): `Organization settings → Billing → Public project parallelism request`. Microsoft enables it manually within a day or two.
|
|
363
386
|
|
|
364
387
|
### Badge
|
|
365
388
|
|
|
@@ -373,10 +396,11 @@ Replace `<org>`, `<project>`, `<id>`. Paste into `README.md` next to the other b
|
|
|
373
396
|
|
|
374
397
|
### Reports
|
|
375
398
|
|
|
376
|
-
The pipeline publishes
|
|
399
|
+
The pipeline publishes three build artefacts, passed or failed:
|
|
377
400
|
|
|
378
|
-
- `cucumber-report` — `tests/reports
|
|
379
|
-
- `
|
|
401
|
+
- `cucumber-report` — `tests/reports/` (the HTML and JSON report, and the PDF when it is generated)
|
|
402
|
+
- `screenshots` — every `screenshots/**/*` capture
|
|
403
|
+
- `videos` — the recordings, when recording is on (`continueOnError`: a run without videos is not a failure)
|
|
380
404
|
|
|
381
405
|
Browse via **Pipelines → Run → Artifacts → 1 published**.
|
|
382
406
|
|
|
@@ -402,11 +426,11 @@ Two `Cache@2` tasks are configured:
|
|
|
402
426
|
|
|
403
427
|
**File**: `buildspec.yml` at repo root.
|
|
404
428
|
|
|
405
|
-
AWS-managed build service.
|
|
429
|
+
AWS-managed build service. For the free tier and the price of a build minute, see the CodeBuild pricing page.
|
|
406
430
|
|
|
407
431
|
### Setup steps — open account + create project
|
|
408
432
|
|
|
409
|
-
1. **Create an AWS account** at <https://aws.amazon.com/>. Requires a credit card, phone verification, and an email confirmation.
|
|
433
|
+
1. **Create an AWS account** at <https://aws.amazon.com/>. Requires a credit card, phone verification, and an email confirmation.
|
|
410
434
|
2. **Sign in to the AWS Console** → switch to a region close to you (e.g. `us-east-1`, `eu-west-1`).
|
|
411
435
|
3. **IAM → Roles → Create role**:
|
|
412
436
|
- Trusted entity: **AWS service** → **CodeBuild**.
|
|
@@ -417,7 +441,7 @@ AWS-managed build service. Free tier: 100 build-minutes per month on the `genera
|
|
|
417
441
|
- Project name: `webship-js`.
|
|
418
442
|
- Source provider: **GitHub** → "Connect using OAuth" → authorise the AWS CodeBuild GitHub app → pick `webship/webship-js` → branch `2.0.x`.
|
|
419
443
|
- Webhook: tick "Rebuild every time a code change is pushed".
|
|
420
|
-
- Environment: **Managed image** → operating system **Ubuntu** → runtime **Standard** → image `aws/codebuild/standard:
|
|
444
|
+
- Environment: **Managed image** → operating system **Ubuntu** → runtime **Standard** → image `aws/codebuild/standard:8.0` (its Node runtimes include the `nodejs: 24` of `buildspec.yml`) → privileged unchecked.
|
|
421
445
|
- Service role: pick the existing `webship-js-codebuild-role` you just created.
|
|
422
446
|
- Build spec: **Use a buildspec file** → buildspec name `buildspec.yml` (default).
|
|
423
447
|
- Artifacts: **Amazon S3** → bucket `webship-js-reports` → name `webship-js-report-$(date)`.
|
|
@@ -436,13 +460,12 @@ CodeBuild has no native badge endpoint. Two common patterns:
|
|
|
436
460
|
`buildspec.yml` declares artefacts:
|
|
437
461
|
|
|
438
462
|
```
|
|
439
|
-
tests/reports
|
|
440
|
-
tests/reports/cucumber_report.pdf
|
|
441
|
-
tests/reports/cucumber_report.json
|
|
463
|
+
tests/reports/**/*
|
|
442
464
|
screenshots/**/*
|
|
465
|
+
videos/**/*
|
|
443
466
|
```
|
|
444
467
|
|
|
445
|
-
They land in the configured S3 bucket. Grant pre-signed URLs or make the bucket public if you want links you can share.
|
|
468
|
+
CodeBuild uploads them after the build phase, passed or failed. They land in the configured S3 bucket. Grant pre-signed URLs or make the bucket public if you want links you can share.
|
|
446
469
|
|
|
447
470
|
### Caching
|
|
448
471
|
|
|
@@ -450,7 +473,6 @@ They land in the configured S3 bucket. Grant pre-signed URLs or make the bucket
|
|
|
450
473
|
|
|
451
474
|
### Notes
|
|
452
475
|
|
|
453
|
-
- 9-min suite × $0.005/min ≈ $0.045 per build past the free tier — cheap unless you push hundreds of builds.
|
|
454
476
|
- For multi-AZ or multi-region resilience, place the buildspec in `aws-codebuild/buildspec.yml` and point the CodeBuild project at that path — the file is just a relative source path.
|
|
455
477
|
- CodeBuild can run inside a VPC if your dev server needs private network access — toggle in **VPC configuration** before starting the first build.
|
|
456
478
|
|
|
@@ -460,11 +482,11 @@ They land in the configured S3 bucket. Grant pre-signed URLs or make the bucket
|
|
|
460
482
|
|
|
461
483
|
**File**: `cloudbuild.yaml` at repo root.
|
|
462
484
|
|
|
463
|
-
Google's managed CI inside GCP.
|
|
485
|
+
Google's managed CI inside GCP. For the free tier and the prices, see the Cloud Build pricing page.
|
|
464
486
|
|
|
465
487
|
### Setup steps — open account + connect repo
|
|
466
488
|
|
|
467
|
-
1. **Create a Google Cloud account** at <https://console.cloud.google.com/>. Sign in with a Google account
|
|
489
|
+
1. **Create a Google Cloud account** at <https://console.cloud.google.com/>. Sign in with a Google account and accept the terms (a card is required for verification).
|
|
468
490
|
2. **Create a Project**: top bar → "Select a project" → "New project" → name `webship-js`. Note the project ID — Cloud Build references it implicitly.
|
|
469
491
|
3. **Enable billing** on the project: `Billing → Link a billing account`. Required even for free-tier-only usage.
|
|
470
492
|
4. **Enable the Cloud Build API**: `APIs & Services → Library → Cloud Build API → Enable`. Wait ~30 s.
|
|
@@ -490,19 +512,19 @@ Cloud Build has no native badge. Two workarounds:
|
|
|
490
512
|
|
|
491
513
|
### Reports
|
|
492
514
|
|
|
493
|
-
|
|
515
|
+
Cloud Build uploads the files of an `artifacts:` block only when every step succeeds, so the pipeline keeps its report in steps of its own: the test step records a failure instead of stopping the build, `keep-report` copies `tests/reports/`, `screenshots/` and `videos/` to `gs://webship-js-reports/<BUILD_ID>/`, and `test-result` then fails the build when the suite failed. Browse via the Cloud Storage UI or share pre-signed URLs.
|
|
494
516
|
|
|
495
517
|
### Caching
|
|
496
518
|
|
|
497
519
|
Cloud Build does not have a first-class cache step. Common patterns:
|
|
498
520
|
|
|
499
521
|
1. **Kaniko image cache** for Docker-based builds (not what this pipeline does).
|
|
500
|
-
2. **Volume cache via `dir` + GCS sync**: copy `node_modules` and `~/.cache/ms-playwright` to GCS at the end of each build, restore at the start. Adds two extra steps
|
|
522
|
+
2. **Volume cache via `dir` + GCS sync**: copy `node_modules` and `~/.cache/ms-playwright` to GCS at the end of each build, restore at the start. Adds two extra steps and shortens a rerun.
|
|
501
523
|
|
|
502
524
|
### Notes
|
|
503
525
|
|
|
504
|
-
- `options.logging: CLOUD_LOGGING_ONLY` skips the legacy log bucket
|
|
505
|
-
- `timeout: 1800s`
|
|
526
|
+
- `options.logging: CLOUD_LOGGING_ONLY` skips the legacy log bucket and avoids the IAM warning Cloud Build prints by default.
|
|
527
|
+
- `timeout: 1800s` is a 30-minute cap on the whole build.
|
|
506
528
|
- `_BRANCH_NAME` and `_ARTIFACT_BUCKET` are substitution variables — override per-trigger to point at a different bucket without forking the YAML.
|
|
507
529
|
- For per-browser parallelism, replace the single `step` with three steps, each setting `BROWSER=chromium/firefox/webkit` — `--with-deps` will fetch the matching browser deps inside the container.
|
|
508
530
|
|
|
@@ -512,12 +534,12 @@ Cloud Build does not have a first-class cache step. Common patterns:
|
|
|
512
534
|
|
|
513
535
|
**Files**: `.teamcity/settings.kts` + `.teamcity/pom.xml` at repo root.
|
|
514
536
|
|
|
515
|
-
JetBrains' CI server, available as Cloud (SaaS, no install) or self-hosted.
|
|
537
|
+
JetBrains' CI server, available as Cloud (SaaS, no install) or self-hosted. For the plans of TeamCity Cloud, see the TeamCity pricing page.
|
|
516
538
|
|
|
517
539
|
### Setup steps — open account + connect repo
|
|
518
540
|
|
|
519
541
|
1. **JetBrains account**: <https://account.jetbrains.com/> → sign up (free, OAuth via GitHub / Google / Microsoft also works).
|
|
520
|
-
2. **Start TeamCity Cloud
|
|
542
|
+
2. **Start TeamCity Cloud**: <https://www.jetbrains.com/teamcity/cloud/> → confirm the JetBrains-issued instance URL (e.g. `https://webship.teamcity.com`).
|
|
521
543
|
3. **Create a Project**: top bar `Administration → Projects → Create project`. Pick "From a repository URL" → paste the GitHub HTTPS URL → "Proceed". TeamCity creates a VCS root.
|
|
522
544
|
4. **Authorise GitHub OAuth**: TeamCity asks for GitHub credentials the first time it touches the repo. Use a Personal Access Token with `repo` scope or the OAuth flow.
|
|
523
545
|
5. **Enable Versioned Settings**: open the project → `Versioned Settings → Synchronization enabled → Kotlin DSL`. TeamCity will offer to scan the repo for `.teamcity/settings.kts` — point it at the file we shipped. Commit any generated config UUIDs back to the repo so the next clone is identical.
|
|
@@ -533,11 +555,11 @@ TeamCity has no native public badge. Common patterns:
|
|
|
533
555
|
|
|
534
556
|
### Reports
|
|
535
557
|
|
|
536
|
-
`artifactRules` archives `tests/reports
|
|
558
|
+
`artifactRules` archives `tests/reports/**`, `screenshots/**` and `videos/**`, and `publishArtifacts = PublishMode.ALWAYS` keeps them for a failed build too. Browse per build under `Artifacts` in the TeamCity UI.
|
|
537
559
|
|
|
538
560
|
### Notes
|
|
539
561
|
|
|
540
|
-
- `dockerImage = "mcr.microsoft.com/playwright:v1.
|
|
562
|
+
- `dockerImage = "mcr.microsoft.com/playwright:v1.65.1-noble"` runs the script inside the official Playwright image of the version the install brings — chromium and every apt dep are already there.
|
|
541
563
|
- `dockerRunParameters = "--user root:root --network host"` keeps the steps simple (no `sudo`, the local fixture server on `localhost:8080` is reachable without port mapping).
|
|
542
564
|
- `pom.xml` exists only so IntelliJ can resolve `configs-dsl-kotlin` types and give completion / inspections in the IDE. TeamCity Cloud ignores it at build time.
|
|
543
565
|
- Kotlin DSL version `2024.03` matches TeamCity Cloud at time of writing — TeamCity warns and offers an auto-upgrade when the server version moves past it.
|
|
@@ -549,12 +571,12 @@ TeamCity has no native public badge. Common patterns:
|
|
|
549
571
|
|
|
550
572
|
**File**: `.semaphore/semaphore.yml`.
|
|
551
573
|
|
|
552
|
-
Hosted CI with a developer-friendly UI and
|
|
574
|
+
Hosted CI with a developer-friendly UI and fast cold-build queues. For the plans and their minutes, see the Semaphore pricing page.
|
|
553
575
|
|
|
554
576
|
### Setup steps — open account + connect repo
|
|
555
577
|
|
|
556
578
|
1. **Sign up**: <https://semaphoreci.com/> → "Sign up with GitHub" → authorise the Semaphore GitHub App on `webship/webship-js`.
|
|
557
|
-
2. **Pick a plan
|
|
579
|
+
2. **Pick a plan** (see the Semaphore pricing page for what each one covers).
|
|
558
580
|
3. **Create project**: dashboard → "Create new project" → pick `webship-js` → branch `2.0.x` (Semaphore can auto-detect other branches later).
|
|
559
581
|
4. **Choose pipeline source**: select "Customise the workflow" → "I have a configuration file in my repository" → point at `.semaphore/semaphore.yml`. Semaphore validates the YAML and shows a graph preview.
|
|
560
582
|
5. **Add the project** → Semaphore queues the first run on a fresh worker. The `--with-deps` step pulls chromium apt deps; the cache stores `node_modules` + `~/.cache/ms-playwright` so reruns are fast.
|
|
@@ -571,7 +593,7 @@ Replace `<org>` with the organisation slug you picked at signup. Paste in `READM
|
|
|
571
593
|
|
|
572
594
|
### Reports
|
|
573
595
|
|
|
574
|
-
`epilogue.always` uploads `
|
|
596
|
+
`epilogue.always` uploads `tests/reports/`, `screenshots/` and `videos/` to the per-job artefact store (`Artifacts` tab in the UI), passed or failed. `--expire-in 30d` purges them after a month — raise it for longer retention.
|
|
575
597
|
|
|
576
598
|
### Caching
|
|
577
599
|
|
|
@@ -586,11 +608,11 @@ Two cache slots are populated in the `Install` block and restored in `prologue`
|
|
|
586
608
|
|
|
587
609
|
### Notes
|
|
588
610
|
|
|
589
|
-
- `sem-version node
|
|
590
|
-
- `agent.machine.type: e1-standard-2` is
|
|
611
|
+
- `sem-version node 24` is Semaphore's runtime switcher — preinstalled on every `os_image: ubuntu2204` agent.
|
|
612
|
+
- `agent.machine.type: e1-standard-2` is a small machine; a bigger one (`e2-standard-4`) shortens the run.
|
|
591
613
|
- `nohup npm start > /tmp/srv.log 2>&1 &` keeps the fixture server alive after the `commands` block exits; `curl -sf` is the same ready-probe as the other lanes.
|
|
592
614
|
- Add a `promotions` block (e.g. tag release, deploy to staging) once the test pipeline is stable — see Semaphore docs for the `auto_promote` shape.
|
|
593
|
-
- For per-browser matrix, add three jobs under the `Test` task and parameterise via env (`BROWSER=chromium` etc.) — Semaphore runs them in parallel within the
|
|
615
|
+
- For per-browser matrix, add three jobs under the `Test` task and parameterise via env (`BROWSER=chromium` etc.) — Semaphore runs them in parallel within the concurrency of your plan.
|
|
594
616
|
|
|
595
617
|
---
|
|
596
618
|
|
|
@@ -598,7 +620,7 @@ Two cache slots are populated in the `Install` block and restored in `prologue`
|
|
|
598
620
|
|
|
599
621
|
**File**: `.drone.yml` at repo root.
|
|
600
622
|
|
|
601
|
-
Open-source CI/CD that pipelines via simple YAML and runs steps in Docker containers.
|
|
623
|
+
Open-source CI/CD that pipelines via simple YAML and runs steps in Docker containers. The open-source path is **self-host**. The shipped `.drone.yml` is provider-agnostic — anyone running a Drone server can enable the repo and go.
|
|
602
624
|
|
|
603
625
|
### Setup steps — open account + bring up a server
|
|
604
626
|
|
|
@@ -636,9 +658,9 @@ There is **no SaaS sign-up** for the free version. You have two routes:
|
|
|
636
658
|
```
|
|
637
659
|
6. Visit `https://ci.example.com` → sign in with GitHub → **Activate** `webship/webship-js`. Drone reads `.drone.yml` on the next push.
|
|
638
660
|
|
|
639
|
-
#### Route B — Drone
|
|
661
|
+
#### Route B — hosted Drone
|
|
640
662
|
|
|
641
|
-
<https://drone.io>
|
|
663
|
+
<https://drone.io> lists the hosted offers. Point it at the same `.drone.yml`; no further config differences.
|
|
642
664
|
|
|
643
665
|
### Badge
|
|
644
666
|
|
|
@@ -650,7 +672,7 @@ Replace `ci.example.com` with your server hostname.
|
|
|
650
672
|
|
|
651
673
|
### Reports
|
|
652
674
|
|
|
653
|
-
The `archive-reports` step tars `tests/reports/`
|
|
675
|
+
The `archive-reports` step, passed or failed, tars `tests/reports/`, `screenshots/` and `videos/` into `/var/lib/drone/artifacts/cucumber-report-<build>.tar.gz` on the host. Serve the directory via a static file server (e.g. `python3 -m http.server` behind nginx) or copy to S3/GCS via an extra step.
|
|
654
676
|
|
|
655
677
|
### Notes
|
|
656
678
|
|
|
@@ -720,7 +742,7 @@ Adjust to your Forgejo host.
|
|
|
720
742
|
|
|
721
743
|
**File**: `.harness/webship-js-pipeline.yml`.
|
|
722
744
|
|
|
723
|
-
Harness ships an enterprise Software Delivery Platform; Harness CI is the build/test module.
|
|
745
|
+
Harness ships an enterprise Software Delivery Platform; Harness CI is the build/test module. For the free plan and its build credits, see the Harness pricing page.
|
|
724
746
|
|
|
725
747
|
### Setup steps — open account + connect repo
|
|
726
748
|
|
|
@@ -741,11 +763,11 @@ Harness ships an enterprise Software Delivery Platform; Harness CI is the build/
|
|
|
741
763
|
|
|
742
764
|
### Badge
|
|
743
765
|
|
|
744
|
-
|
|
766
|
+
Expose the status via the GitHub commit status that the Harness GitHub App posts automatically, or write a tiny shields.io endpoint backed by the Harness REST API (`GET /pipeline/api/pipelines/execution`).
|
|
745
767
|
|
|
746
768
|
### Reports
|
|
747
769
|
|
|
748
|
-
The shipped pipeline includes an optional `Upload report artefacts` step that uses the `plugins/s3` connector
|
|
770
|
+
The shipped pipeline includes an optional `Upload report artefacts` step (run whatever the stage status) that uses the `plugins/s3` connector to upload `tests/reports/`, `screenshots/` and `videos/`. Replace the secret IDs and bucket name; or rip the step out entirely and pull reports from Harness's built-in **CI Insights** tab (test logs are retained per-build).
|
|
749
771
|
|
|
750
772
|
### Notes
|
|
751
773
|
|
|
@@ -760,13 +782,13 @@ The shipped pipeline includes an optional `Upload report artefacts` step that us
|
|
|
760
782
|
|
|
761
783
|
**File**: `bamboo-specs/bamboo.yml`.
|
|
762
784
|
|
|
763
|
-
Atlassian's on-prem CI/CD
|
|
785
|
+
Atlassian's on-prem CI/CD: Atlassian offers Bamboo as **Data Center** only, self-hosted. The shipped YAML targets the official YAML Specs format introduced in Bamboo 7+.
|
|
764
786
|
|
|
765
787
|
### Setup steps — open account + connect repo
|
|
766
788
|
|
|
767
789
|
There is no Atlassian-hosted Bamboo any more. You bring your own server.
|
|
768
790
|
|
|
769
|
-
1. **
|
|
791
|
+
1. **Get a Bamboo Data Center licence** (or an evaluation licence) from Atlassian: <https://www.atlassian.com/software/bamboo>.
|
|
770
792
|
2. **Install Bamboo Data Center**:
|
|
771
793
|
- Recommended path: official Docker image `atlassian/bamboo` on a host with at least 4 GB RAM and a persistent volume.
|
|
772
794
|
- Database: PostgreSQL 13+ or MySQL 8+ is supported; SQLite for tiny installs.
|
|
@@ -774,7 +796,7 @@ There is no Atlassian-hosted Bamboo any more. You bring your own server.
|
|
|
774
796
|
3. **Sign in as admin** at `https://bamboo.example.com` → run the setup wizard → activate the licence.
|
|
775
797
|
4. **Link the GitHub repository**: `Bamboo administration → Linked repositories → Add → Git`. Use HTTPS + a Personal Access Token, or SSH with a deploy key. Name the linked repo `webship-js`.
|
|
776
798
|
5. **Enable Bamboo Specs scanning** on that repo: `Bamboo administration → Specs → Repositories → Add`. Bamboo reads `bamboo-specs/bamboo.yml` on every push, recreating plan + permissions from the file.
|
|
777
|
-
6. **Build agent**: at least one Docker-capable agent must be online. The plan runs inside `mcr.microsoft.com/playwright:v1.
|
|
799
|
+
6. **Build agent**: at least one Docker-capable agent must be online. The plan runs inside `mcr.microsoft.com/playwright:v1.65.1-noble`, so the host needs Docker installed and the Bamboo agent needs the Docker plugin enabled.
|
|
778
800
|
|
|
779
801
|
### Badge
|
|
780
802
|
|
|
@@ -785,12 +807,11 @@ Bamboo emits chat-style status webhooks (Slack, MS Teams) but no native badge im
|
|
|
785
807
|
|
|
786
808
|
### Reports
|
|
787
809
|
|
|
788
|
-
`Cucumber.artifacts` declares
|
|
810
|
+
`Cucumber.artifacts` declares three shared artefacts:
|
|
789
811
|
|
|
790
|
-
- `cucumber-report
|
|
791
|
-
- `
|
|
792
|
-
- `
|
|
793
|
-
- `screenshots` → `screenshots/**` (failure captures)
|
|
812
|
+
- `cucumber-report` → `tests/reports/**`
|
|
813
|
+
- `screenshots` → `screenshots/**`
|
|
814
|
+
- `videos` → `videos/**`
|
|
794
815
|
|
|
795
816
|
Browse per build under `Plan Result → Artifacts`. The `shared: true` flag makes them available to downstream plans and to the Bamboo REST API.
|
|
796
817
|
|
|
@@ -808,12 +829,12 @@ Browse per build under `Plan Result → Artifacts`. The `shared: true` flag make
|
|
|
808
829
|
|
|
809
830
|
**File**: `codefresh.yml` at repo root.
|
|
810
831
|
|
|
811
|
-
Kubernetes-native CI/CD. The Classic pipeline format reads `codefresh.yml` from the repo.
|
|
832
|
+
Kubernetes-native CI/CD. The Classic pipeline format reads `codefresh.yml` from the repo. For the plans and their build capacity, see the Codefresh pricing page.
|
|
812
833
|
|
|
813
834
|
### Setup steps — open account + connect repo
|
|
814
835
|
|
|
815
836
|
1. **Sign up**: <https://g.codefresh.io/signup> → "Sign up with GitHub" → authorise the Codefresh GitHub App on `webship/webship-js`.
|
|
816
|
-
2. **Pick a runtime**: dashboard prompts you to "Add Runtime" → pick **Codefresh Hosted** for the managed
|
|
837
|
+
2. **Pick a runtime**: dashboard prompts you to "Add Runtime" → pick **Codefresh Hosted** for the managed one. (Self-hosted runtimes via `cf-runtime install` are also available but out of scope here.)
|
|
817
838
|
3. **Create a pipeline**:
|
|
818
839
|
- `Pipelines → New Pipeline → From Git`.
|
|
819
840
|
- Repository `webship/webship-js`, branch `2.0.x`.
|
|
@@ -832,10 +853,10 @@ Replace `<account>` with the Codefresh account slug picked at signup and `<pipel
|
|
|
832
853
|
|
|
833
854
|
### Reports
|
|
834
855
|
|
|
835
|
-
The `upload_reports` step copies `
|
|
856
|
+
The `upload_reports` step, passed or failed, copies `tests/reports/`, `screenshots/` and `videos/` to `/codefresh/volume/cucumber-report/` — a Codefresh-managed shared volume that persists across pipeline runs. From there you can:
|
|
836
857
|
|
|
837
858
|
1. Mount the same volume in a follow-up step that uploads to S3/GCS.
|
|
838
|
-
2. Browse via the **Codefresh storage browser
|
|
859
|
+
2. Browse via the **Codefresh storage browser**, on the plans that have it.
|
|
839
860
|
3. Pipe to the built-in **Test Reports** feature by emitting JUnit XML — add a `--format junit:tests/reports/junit.xml` argument to the cucumber-js call.
|
|
840
861
|
|
|
841
862
|
### Notes
|
|
@@ -862,8 +883,8 @@ Octopus Deploy is a release-orchestration tool. It does not run unit / integrati
|
|
|
862
883
|
|
|
863
884
|
### Setup steps — open account
|
|
864
885
|
|
|
865
|
-
1. **Octopus Cloud** (SaaS): <https://octopus.com/start> → sign in with email or Google
|
|
866
|
-
2. **Octopus Server** (self-hosted): download the Windows / Linux installer from <https://octopus.com/downloads>.
|
|
886
|
+
1. **Octopus Cloud** (SaaS): <https://octopus.com/start> → sign in with email or Google. See the Octopus pricing page for the free and paid plans.
|
|
887
|
+
2. **Octopus Server** (self-hosted): download the Windows / Linux installer from <https://octopus.com/downloads>.
|
|
867
888
|
|
|
868
889
|
### Wire any CI lane into Octopus
|
|
869
890
|
|
|
@@ -892,4 +913,4 @@ Plug that snippet into any of the YAML files we ship — Octopus does not care w
|
|
|
892
913
|
|
|
893
914
|
## Codeship
|
|
894
915
|
|
|
895
|
-
**Service retired by CloudBees
|
|
916
|
+
**Service retired by CloudBees.** Do not add a Codeship config. Existing `codeship-steps.yml` / `codeship-services.yml` files on the internet are dead. If a tutorial references Codeship, treat it as Tier-1 advice for **Travis** or **CircleCI** instead — both ship the same `npm test` pattern.
|