@flakiness/sdk 2.4.0 → 2.6.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 +2 -1
- package/lib/index.js +4 -0
- package/package.json +1 -1
- package/types/src/ciUtils.d.ts +7 -0
- package/types/src/ciUtils.d.ts.map +1 -1
package/README.md
CHANGED
|
@@ -34,6 +34,7 @@ const env = ReportUtils.createEnvironment({ name: 'CI' });
|
|
|
34
34
|
const report: FlakinessReport.Report = {
|
|
35
35
|
category: 'testreport',
|
|
36
36
|
commitId: worktree.headCommitId(),
|
|
37
|
+
title: process.env.FLAKINESS_TITLE,
|
|
37
38
|
url: CIUtils.runUrl(),
|
|
38
39
|
environments: [env],
|
|
39
40
|
suites: [{
|
|
@@ -82,7 +83,7 @@ Use this entry point when you need to process or manipulate reports in browser-b
|
|
|
82
83
|
## Top-Level Exports
|
|
83
84
|
|
|
84
85
|
### Building Reports
|
|
85
|
-
- **`CIUtils`** - Utilities to extract CI/CD information (run URLs, environment detection)
|
|
86
|
+
- **`CIUtils`** - Utilities to extract CI/CD information (run URLs, run titles, environment detection)
|
|
86
87
|
- **`GithubOIDC`** - GitHub Actions OIDC integration for passwordless Flakiness.io authentication
|
|
87
88
|
- **`GitWorktree`** - Git repository utilities for path conversion and commit information
|
|
88
89
|
- **`ReportUtils`** - Namespace with utilities for report creation and manipulation:
|
package/lib/index.js
CHANGED
|
@@ -7,6 +7,10 @@ var __export = (target, all) => {
|
|
|
7
7
|
// src/ciUtils.ts
|
|
8
8
|
var CIUtils;
|
|
9
9
|
((CIUtils2) => {
|
|
10
|
+
function runTitle() {
|
|
11
|
+
return void 0;
|
|
12
|
+
}
|
|
13
|
+
CIUtils2.runTitle = runTitle;
|
|
10
14
|
function runUrl() {
|
|
11
15
|
return githubActions() ?? azure() ?? process.env.CI_JOB_URL ?? process.env.BUILD_URL;
|
|
12
16
|
}
|
package/package.json
CHANGED
package/types/src/ciUtils.d.ts
CHANGED
|
@@ -5,6 +5,13 @@
|
|
|
5
5
|
* from various CI/CD environments, including GitHub Actions, Azure DevOps, Jenkins, and others.
|
|
6
6
|
*/
|
|
7
7
|
export declare namespace CIUtils {
|
|
8
|
+
/**
|
|
9
|
+
* @deprecated Use the `title` reporter option or `FLAKINESS_TITLE` environment variable instead.
|
|
10
|
+
* See https://docs.flakiness.io/report/customization/#title
|
|
11
|
+
*
|
|
12
|
+
* @returns {undefined} Always returns `undefined`.
|
|
13
|
+
*/
|
|
14
|
+
function runTitle(): string | undefined;
|
|
8
15
|
/**
|
|
9
16
|
* Automatically extracts the run URL for common continuous integration providers.
|
|
10
17
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ciUtils.d.ts","sourceRoot":"","sources":["../../src/ciUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAgB,MAAM,IAAI,MAAM,GAAG,SAAS,CAE3C;CACF"}
|
|
1
|
+
{"version":3,"file":"ciUtils.d.ts","sourceRoot":"","sources":["../../src/ciUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;;;OAKG;IACH,SAAgB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAE7C;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAgB,MAAM,IAAI,MAAM,GAAG,SAAS,CAE3C;CACF"}
|