@flakiness/cucumberjs 1.1.1 → 1.3.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.
package/README.md CHANGED
@@ -30,6 +30,7 @@ A custom CucumberJS formatter that generates Flakiness Reports from your Cucumbe
30
30
  - [CI Integration](#ci-integration)
31
31
  - [Configuration Options](#configuration-options)
32
32
  - [`flakinessProject?: string`](#flakinessproject-string)
33
+ - [`title?: string`](#title-string)
33
34
  - [`endpoint?: string`](#endpoint-string)
34
35
  - [`token?: string`](#token-string)
35
36
  - [`outputFolder?: string`](#outputfolder-string)
@@ -142,6 +143,18 @@ formatOptions: {
142
143
  }
143
144
  ```
144
145
 
146
+ ### `title?: string`
147
+
148
+ Optional human-readable report title. Typically used to name a CI run, matrix shard, or other execution group.
149
+
150
+ Defaults to the `FLAKINESS_TITLE` environment variable, or empty otherwise.
151
+
152
+ ```javascript
153
+ formatOptions: {
154
+ title: 'Shard 1/4 — Linux Chrome',
155
+ }
156
+ ```
157
+
145
158
  ### `endpoint?: string`
146
159
 
147
160
  Custom Flakiness.io endpoint URL for uploading reports. Defaults to the `FLAKINESS_ENDPOINT` environment variable, or `https://flakiness.io` if not set.
@@ -200,6 +213,7 @@ export default {
200
213
  ],
201
214
  formatOptions: {
202
215
  flakinessProject: 'my-org/my-project',
216
+ title: 'My Test Run',
203
217
  endpoint: process.env.FLAKINESS_ENDPOINT,
204
218
  token: process.env.FLAKINESS_ACCESS_TOKEN,
205
219
  outputFolder: './flakiness-report',
package/lib/formatter.js CHANGED
@@ -95,6 +95,7 @@ class FlakinessCucumberFormatter extends Formatter {
95
95
  })
96
96
  ],
97
97
  flakinessProject: this._config.flakinessProject,
98
+ title: this._config.title ?? process.env.FLAKINESS_TITLE,
98
99
  suites,
99
100
  startTimestamp: this._startTimestamp,
100
101
  url: CIUtils.runUrl()
@@ -199,6 +200,7 @@ function parseFormatterConfig(parsedArgvOptions) {
199
200
  endpoint: typeof parsedArgvOptions.endpoint === "string" ? parsedArgvOptions.endpoint : void 0,
200
201
  flakinessProject: typeof parsedArgvOptions.flakinessProject === "string" ? parsedArgvOptions.flakinessProject : void 0,
201
202
  outputFolder: typeof parsedArgvOptions.outputFolder === "string" ? parsedArgvOptions.outputFolder : void 0,
203
+ title: typeof parsedArgvOptions.title === "string" ? parsedArgvOptions.title : void 0,
202
204
  token: typeof parsedArgvOptions.token === "string" ? parsedArgvOptions.token : void 0
203
205
  };
204
206
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flakiness/cucumberjs",
3
- "version": "1.1.1",
3
+ "version": "1.3.0",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/flakiness/cucumberjs.git"
@@ -20,13 +20,13 @@
20
20
  "license": "MIT",
21
21
  "type": "module",
22
22
  "dependencies": {
23
- "@flakiness/flakiness-report": "^0.28.0",
24
- "@flakiness/sdk": "^2.4.0"
23
+ "@flakiness/flakiness-report": "^0.29.0",
24
+ "@flakiness/sdk": "^2.6.0"
25
25
  },
26
26
  "devDependencies": {
27
27
  "@cucumber/cucumber": "^12.7.0",
28
28
  "@cucumber/messages": "^32.2.0",
29
- "@flakiness/cucumberjs": "1.0.1",
29
+ "@flakiness/cucumberjs": "1.2.0",
30
30
  "@types/node": "^25.5.0",
31
31
  "c8": "^11.0.0",
32
32
  "esbuild": "^0.27.4",
@@ -1 +1 @@
1
- {"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAoB,MAAM,oBAAoB,CAAC;AAuDjE,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,SAAS;IAC/D,MAAM,CAAC,aAAa,SAAwD;IAE5E,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAoC;IAC3D,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,oBAAoB,CAAsC;IAClE,OAAO,CAAC,qBAAqB,CAAuC;gBAExD,OAAO,EAAE,iBAAiB;IA0BtC,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,mBAAmB;IAIZ,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAaxC,OAAO,CAAC,aAAa;YAMP,kBAAkB;YAqDlB,cAAc;CA4F7B"}
1
+ {"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAoB,MAAM,oBAAoB,CAAC;AAwDjE,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,SAAS;IAC/D,MAAM,CAAC,aAAa,SAAwD;IAE5E,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAoC;IAC3D,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,oBAAoB,CAAsC;IAClE,OAAO,CAAC,qBAAqB,CAAuC;gBAExD,OAAO,EAAE,iBAAiB;IA0BtC,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,mBAAmB;IAIZ,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAaxC,OAAO,CAAC,aAAa;YAMP,kBAAkB;YAsDlB,cAAc;CA4F7B"}