testdossier 0.2.1 → 0.2.3

package/README.md

@@ -1,16 +1,27 @@
+<img src="https://raw.githubusercontent.com/devkalu/test-dossier/main/cli/assets/mark.svg" width="44" height="44" alt="TestDossier">
+
 # TestDossier CLI
 
+**Publish test evidence from CI without adding another agent, daemon, or hosted runner.**
+
 Upload a completed test report from a developer laptop, test machine, or CI
 job. Run these commands in the project containing your automated tests:
 
-1. One-time setup — creates `.env.testdossier` with owner-only permissions and
+1. Install the latest CLI in the project. To pin a release instead, replace
+   `@latest` with an exact version such as `@0.2.3`:
+
+```bash
+npm install --save-dev testdossier@latest
+```
+
+2. One-time setup — creates `.env.testdossier` with owner-only permissions and
    adds it to `.gitignore`:
 
 ```bash
 npx testdossier init
 ```
 
-2. Paste the CI-ingestion token shown once by TestDossier into
+3. Paste the CI-ingestion token shown once by TestDossier into
    `.env.testdossier`, replacing the placeholder, then prove the wiring in
    seconds instead of after a full CI round-trip:
 
@@ -22,14 +33,14 @@ npx testdossier verify
 token is valid, has the CI-ingestion capability, and reaches the right
 project — and prints that project's name.
 
-3. Run your tests so they create a supported report. For example, with
+4. Run your tests so they create a supported report. For example, with
    Playwright's JSON reporter configured to write `playwright-results.json`:
 
 ```bash
 npx playwright test
 ```
 
-4. Upload the completed report:
+5. Upload the completed report:
 
 ```bash
 npx testdossier upload playwright-results.json
@@ -79,18 +90,18 @@ delete the file to change it.
 Before sending anything, inspect what the CLI detected:
 
 ```bash
-npx --yes testdossier@0.2.1 upload playwright-results.json --dry-run
+npx testdossier upload playwright-results.json --dry-run
 ```
 
 ## Supported reports
 
 | Runner or format | Example |
 |---|---|
-| Playwright JSON | `npx --yes testdossier@0.2.1 upload playwright-results.json` |
-| Cypress JSON | `npx --yes testdossier@0.2.1 upload cypress-results.json` |
-| Cucumber JSON | `npx --yes testdossier@0.2.1 upload cucumber-results.json` |
-| JUnit XML | `npx --yes testdossier@0.2.1 upload junit-results.xml` |
-| Generic JSON | `npx --yes testdossier@0.2.1 upload testdossier-ci.json` |
+| Playwright JSON | `npx testdossier upload playwright-results.json` |
+| Cypress JSON | `npx testdossier upload cypress-results.json` |
+| Cucumber JSON | `npx testdossier upload cucumber-results.json` |
+| JUnit XML | `npx testdossier upload junit-results.xml` |
+| Generic JSON | `npx testdossier upload testdossier-ci.json` |
 
 Detection uses the report's contents, not its filename. If a custom reporter
 creates an ambiguous shape, pass `--format playwright`, `--format cypress`,
@@ -103,10 +114,14 @@ For repeat use, install and pin the CLI in the test repository so its source
 and version are captured by the lockfile:
 
 ```bash
-npm install --save-dev testdossier
+npm install --save-dev testdossier@latest
 npx testdossier init
 ```
 
+Use `npm install --save-dev testdossier@0.2.3` when the repository should pin
+that exact release. In either case, subsequent commands remain
+`npx testdossier ...`; the version selector belongs only to installation.
+
 `init` is idempotent: it never overwrites an existing `.env.testdossier` and
 never duplicates the `.gitignore` entry. If you prefer manual setup, create
 `.env.testdossier` yourself with the single line
@@ -134,7 +149,8 @@ Useful metadata options:
 npx testdossier upload junit-results.xml \
   --run-id "local-2026-07-23-1" \
   --build "abc123" \
-  --branch "main"
+  --branch "main" \
+  --pipeline-id "github:acme/storefront:e2e"
 ```
 
 `--run-id` is the idempotency key. Repeating the same upload with the same run
@@ -145,18 +161,30 @@ page identity includes the report's file name and a path fingerprint). Without
 a run ID, the CLI creates a new local one. Transient network, rate-limit,
 conflict, and server errors are retried with the same run ID.
 
+`--pipeline-id` identifies the stable repository/workflow/job that produced the
+run. It is inferred on supported CI providers and can also be set with
+`TD_PIPELINE_ID`. Keep it stable across access-token rotation: Insights uses it
+to let the latest completed result replace an earlier result from the same
+pipeline without allowing another repository's result to be overwritten.
+
 Run `npx testdossier --help` for every option.
 
 ## Using the same flow in CI
 
 Commit `testdossier.json` and set `TD_CI_TOKEN` in the provider's encrypted
-secret storage; the pipeline step is then `npx --yes testdossier@0.2.1` with
+secret storage; after the dependency install, the pipeline step is
+`npx testdossier` with
 no arguments. Run identity, build, branch, and provider metadata are inferred
 automatically on GitHub Actions, GitLab CI, Jenkins, Azure DevOps, Bitbucket
 Pipelines, and CircleCI. The Access Tokens dialog still generates
 provider-specific snippets that pass the report path explicitly — either style
 works; the explicit one fails louder when the report artifact is missing.
 
+Use `@latest` only when adding/updating the dependency. The lockfile then keeps
+CI reproducible, and normal invocations use the installed command without a
+version selector. Update or pin the dependency through your normal dependency
+update process.
+
 If `.env.testdossier` is ever committed or shared, revoke that token in
 TestDossier immediately and create a replacement. Hosted CI should use the
 provider's encrypted secret storage instead of an env file.

package/assets/mark.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="TestDossier">
+  <title>TestDossier</title>
+  <path fill="#006b61" fill-rule="evenodd" d="M20 6h14c17 0 28 10 28 26S51 58 34 58H20V6Zm14 14v24c9 0 14-4 14-12s-5-12-14-12Z"/>
+  <path fill="#006b61" d="M2 6h32v10H2z"/>
+</svg>

package/lib/testdossier.mjs

@@ -2,7 +2,7 @@ import { createHash, randomUUID } from "node:crypto";
 import { readFile, stat, writeFile } from "node:fs/promises";
 import { basename, isAbsolute, join, relative, resolve, sep } from "node:path";
 
-export const VERSION = "0.2.1";
+export const VERSION = "0.2.3";
 const DEFAULT_ORIGIN = "https://testdossier.com";
 const ENV_FILE_NAME = ".env.testdossier";
 const CONFIG_FILE_NAME = "testdossier.json";
@@ -347,6 +347,7 @@ export function parseUploadArgs(args) {
     build: undefined,
     branch: undefined,
     provider: undefined,
+    pipelineId: undefined,
     ciUrl: undefined,
     envFile: undefined,
     dryRun: false,
@@ -359,6 +360,7 @@ export function parseUploadArgs(args) {
     ["--build", "build"],
     ["--branch", "branch"],
     ["--provider", "provider"],
+    ["--pipeline-id", "pipelineId"],
     ["--ci-url", "ciUrl"],
     ["--env-file", "envFile"],
   ]);
@@ -569,6 +571,46 @@ function inferredProvider(env) {
   return "local";
 }
 
+function boundedPipelineId(value) {
+  const normalized = normalizedHeader(value, "pipeline id");
+  if (normalized.length <= 200) return normalized;
+  const digest = createHash("sha256").update(normalized).digest("hex").slice(0, 20);
+  return `${normalized.slice(0, 175)}-${digest}`;
+}
+
+function inferredPipelineId(env, provider) {
+  if (provider === "github_actions") {
+    const repository = env.GITHUB_REPOSITORY || "unknown-repository";
+    const refPrefix = `${repository}/`;
+    const workflowRef = String(env.GITHUB_WORKFLOW_REF || "").split("@")[0];
+    const workflow = workflowRef.startsWith(refPrefix)
+      ? workflowRef.slice(refPrefix.length)
+      : workflowRef || env.GITHUB_WORKFLOW || "workflow";
+    return [provider, repository, workflow, env.GITHUB_JOB || "job"].join(":");
+  }
+  if (provider === "gitlab_ci") {
+    return [provider, env.CI_PROJECT_PATH || "unknown-project", env.CI_JOB_NAME || "job"].join(":");
+  }
+  if (provider === "azure_devops") {
+    return [
+      provider,
+      env.SYSTEM_TEAMPROJECT || "unknown-project",
+      env.BUILD_REPOSITORY_NAME || env.BUILD_REPOSITORY_ID || "repository",
+      env.SYSTEM_DEFINITIONID || env.BUILD_DEFINITIONNAME || "pipeline",
+      env.SYSTEM_JOBDISPLAYNAME || env.SYSTEM_JOBID || "job",
+    ].join(":");
+  }
+  if (provider === "bitbucket_pipelines") {
+    return [provider, env.BITBUCKET_REPO_FULL_NAME || "unknown-repository"].join(":");
+  }
+  if (provider === "circleci") {
+    const repository = [env.CIRCLE_PROJECT_USERNAME, env.CIRCLE_PROJECT_REPONAME].filter(Boolean).join("/") || "unknown-repository";
+    return [provider, repository, env.CIRCLE_JOB || "job"].join(":");
+  }
+  if (provider === "jenkins") return [provider, env.JOB_NAME || "job"].join(":");
+  return `${provider || "local"}:local`;
+}
+
 function inferredMetadata(options, env) {
   // The job identifier is part of every inferred key: two jobs of one
   // workflow/pipeline run would otherwise share a run id, and the server
@@ -618,7 +660,10 @@ function inferredMetadata(options, env) {
     "CI URL",
     500,
   );
-  return { runId, build, branch, provider, ciUrl };
+  const pipelineId = boundedPipelineId(
+    options.pipelineId || env.TD_PIPELINE_ID || inferredPipelineId(env, provider),
+  );
+  return { runId, build, branch, provider, ciUrl, pipelineId };
 }
 
 function integerEnv(value, fallback, min, max) {
@@ -755,7 +800,8 @@ async function postWithRetry({ endpoint, headers, body, env, fetchImpl, stderr,
 }
 
 function helpText() {
-  return `TestDossier report uploader ${VERSION}
+  return `TD  TestDossier
+    CI report uploader · ${VERSION}
 
 Usage:
   testdossier init                  One-time setup: create ${ENV_FILE_NAME} and gitignore it
@@ -771,6 +817,7 @@ Options:
   --build <value>     Commit, build number, or release identifier
   --branch <value>    Branch name
   --provider <value>  Provider label (defaults to local or detected CI)
+  --pipeline-id <id>  Stable repository/workflow/job identity (normally inferred)
   --ci-url <url>      Link to the originating CI run
   --env-file <path>   Read TD_CI_TOKEN from this explicit dotenv file
   --dry-run           Validate and detect only; send nothing
@@ -958,6 +1005,7 @@ export async function runCli(
       "User-Agent": `testdossier-cli/${VERSION}`,
       "X-CI-Run-Id": metadata.runId,
       "X-CI-Provider": metadata.provider,
+      "X-CI-Pipeline-Id": metadata.pipelineId,
     };
     if (format !== "junit" && format !== "generic") baseHeaders["X-CI-Format"] = format;
     if (metadata.build) baseHeaders["X-Build"] = metadata.build;
@@ -983,6 +1031,9 @@ export async function runCli(
         headers: {
           ...baseHeaders,
           "X-CI-Page-Id": pages.length === 1 ? pageBase : `${pageBase}-${index + 1}`,
+          "X-CI-Upload-Id": pageBase,
+          "X-CI-Page-Index": String(index + 1),
+          "X-CI-Page-Count": String(pages.length),
         },
         body: page.body,
         env,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testdossier",
-  "version": "0.2.1",
-  "description": "Upload completed test reports to TestDossier from a local machine or CI.",
+  "version": "0.2.3",
+  "description": "Upload Playwright, Cypress, Cucumber, JUnit, and JSON test evidence to TestDossier.",
   "license": "MIT",
   "type": "module",
   "bin": {
@@ -10,6 +10,7 @@
   "files": [
     "bin",
     "lib",
+    "assets",
     "README.md",
     "LICENSE",
     ".env.testdossier.example"
@@ -18,7 +19,13 @@
     "node": ">=18"
   },
   "homepage": "https://testdossier.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/devkalu/test-dossier.git",
+    "directory": "cli"
+  },
   "bugs": {
+    "url": "https://github.com/devkalu/test-dossier/issues",
     "email": "support@testdossier.com"
   },
   "keywords": [
@@ -27,7 +34,11 @@
     "playwright",
     "cypress",
     "cucumber",
-    "testdossier"
+    "testdossier",
+    "test-management",
+    "test-evidence",
+    "continuous-integration",
+    "qa"
   ],
   "publishConfig": {
     "access": "public"