@flakiness/sdk 2.4.0 → 2.5.0

package/README.md

@@ -34,6 +34,7 @@ const env = ReportUtils.createEnvironment({ name: 'CI' });
 const report: FlakinessReport.Report = {
   category: 'testreport',
   commitId: worktree.headCommitId(),
+  title: CIUtils.runTitle(),
   url: CIUtils.runUrl(),
   environments: [env],
   suites: [{
@@ -82,7 +83,7 @@ Use this entry point when you need to process or manipulate reports in browser-b
 ## Top-Level Exports
 
 ### Building Reports
-- **`CIUtils`** - Utilities to extract CI/CD information (run URLs, environment detection)
+- **`CIUtils`** - Utilities to extract CI/CD information (run URLs, run titles, environment detection)
 - **`GithubOIDC`** - GitHub Actions OIDC integration for passwordless Flakiness.io authentication
 - **`GitWorktree`** - Git repository utilities for path conversion and commit information
 - **`ReportUtils`** - Namespace with utilities for report creation and manipulation:

package/lib/index.js

@@ -7,11 +7,19 @@ var __export = (target, all) => {
 // src/ciUtils.ts
 var CIUtils;
 ((CIUtils2) => {
+  function runTitle() {
+    return githubActionsTitle();
+  }
+  CIUtils2.runTitle = runTitle;
   function runUrl() {
     return githubActions() ?? azure() ?? process.env.CI_JOB_URL ?? process.env.BUILD_URL;
   }
   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.4.0",
+  "version": "2.5.0",
   "private": false,
   "repository": {
     "type": "git",

package/types/src/ciUtils.d.ts

@@ -5,6 +5,27 @@
  * from various CI/CD environments, including GitHub Actions, Azure DevOps, Jenkins, and others.
  */
 export declare namespace CIUtils {
+    /**
+     * Automatically extracts a human-readable CI run title when available.
+     *
+     * 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(),
+     * };
+     * ```
+     */
+    function runTitle(): string | undefined;
     /**
      * Automatically extracts the run URL for common continuous integration providers.
      *

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;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAgB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAE7C;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAgB,MAAM,IAAI,MAAM,GAAG,SAAS,CAE3C;CACF"}