chore: depreacte CIUtils.runTitle() method (#20)

Turns out there's no good way to extract title from the CI.

Author: aslushnikov

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: [{

src/ciUtils.ts

@@ -6,27 +6,13 @@
  */
 export 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`.
    */
   export function runTitle(): string | undefined {
-    return githubActionsTitle();
+    return undefined;
   }
 
   /**
@@ -57,11 +43,6 @@ export namespace CIUtils {
   }
 }
 
-function githubActionsTitle(): string | undefined {
-  const title = process.env.GITHUB_WORKFLOW?.trim();
-  return title || undefined;
-}
-
 function githubActions(): string | undefined {
   const serverUrl = process.env.GITHUB_SERVER_URL || 'https://github.com';
   const repo = process.env.GITHUB_REPOSITORY;

tests/ciutils.spec.ts

@@ -13,8 +13,7 @@ test('returns a valid GitHub Actions URL', () => {
   expect(() => new URL(url!)).not.toThrow();
 });
 
-test('returns a valid runTitle', () => {
-  test.skip(!isGitHubActions, 'Only runs in GitHub Actions');
+test('runTitle is deprecated and returns undefined', () => {
   const title = CIUtils.runTitle();
-  expect(title).toBeTruthy();
+  expect(title).toBeUndefined();
 });