@flakiness/sdk 2.5.0 → 2.6.0

package/README.md

@@ -34,7 +34,7 @@ const env = ReportUtils.createEnvironment({ name: 'CI' });
 const report: FlakinessReport.Report = {
   category: 'testreport',
   commitId: worktree.headCommitId(),
-  title: CIUtils.runTitle(),
+  title: process.env.FLAKINESS_TITLE,
   url: CIUtils.runUrl(),
   environments: [env],
   suites: [{

package/lib/index.js

@@ -8,7 +8,7 @@ var __export = (target, all) => {
 var CIUtils;
 ((CIUtils2) => {
   function runTitle() {
-    return githubActionsTitle();
+    return void 0;
   }
   CIUtils2.runTitle = runTitle;
   function runUrl() {
@@ -16,10 +16,6 @@ var CIUtils;
   }
   CIUtils2.runUrl = runUrl;
 })(CIUtils || (CIUtils = {}));
-function githubActionsTitle() {
-  const title = process.env.GITHUB_WORKFLOW?.trim();
-  return title || void 0;
-}
 function githubActions() {
   const serverUrl = process.env.GITHUB_SERVER_URL || "https://github.com";
   const repo = process.env.GITHUB_REPOSITORY;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "private": false,
   "repository": {
     "type": "git",

package/types/src/ciUtils.d.ts

@@ -6,24 +6,10 @@
  */
 export declare namespace CIUtils {
     /**
-     * Automatically extracts a human-readable CI run title when available.
+     * @deprecated Use the `title` reporter option or `FLAKINESS_TITLE` environment variable instead.
+     * See https://docs.flakiness.io/report/customization/#title
      *
-     * This function attempts to detect the current CI environment and return a
-     * stable title that identifies the workflow or pipeline generating the report.
-     *
-     * Supported CI providers (checked in order):
-     * - GitHub Actions (via `GITHUB_WORKFLOW`)
-     *
-     * @returns {string | undefined} The CI run title, or `undefined` if no supported
-     *   CI environment exposes a stable human-readable title.
-     *
-     * @example
-     * ```typescript
-     * const report: FlakinessReport.Report = {
-     *   // ... other report properties
-     *   title: CIUtils.runTitle(),
-     * };
-     * ```
+     * @returns {undefined} Always returns `undefined`.
      */
     function runTitle(): string | undefined;
     /**

package/types/src/ciUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ciUtils.d.ts","sourceRoot":"","sources":["../../src/ciUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAgB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAE7C;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAgB,MAAM,IAAI,MAAM,GAAG,SAAS,CAE3C;CACF"}
+{"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"}