@testream/playwright-reporter 0.3.0 → 0.4.1

package/LICENSE

@@ -1,20 +1,19 @@
 Proprietary License
 
-Copyright (c) 2025 Jira Test Manager Team. All rights reserved.
+Copyright (c) 2026 Testream Team. All rights reserved.
 
 This software and associated documentation files (the "Software") are licensed,
 not sold, to you for use only under the terms of this license.
 
 GRANT OF LICENSE:
 You are granted a non-exclusive, non-transferable license to use the Software
-solely for the purpose of integrating test result reporting with the Jira Test
-Manager service.
+solely for the purpose of integrating test result reporting with the Testream service.
 
 RESTRICTIONS:
 - You may not modify, adapt, or create derivative works of the Software
 - You may not distribute, sublicense, lease, or rent the Software
 - You may not reverse engineer, decompile, or disassemble the Software
-- The Software may only be used in conjunction with the Jira Test Manager service
+- The Software may only be used in conjunction with the Testream service
 
 OWNERSHIP:
 The Software is licensed, not sold. This license does not grant you any rights

package/README.md

@@ -1,300 +1,29 @@
 # @testream/playwright-reporter
 
-Playwright reporter that generates [CTRF](https://ctrf.io/) (Common Test Report Format) test reports and automatically uploads them with artifacts to your Jira Test Manager backend.
+Bridges Playwright test runs from your codebase into Jira with Testream. Once configured, it uploads results automatically.
 
-## Features
+- **Docs:** https://testream.github.io/docs/reporters/playwright
+- **Docs repository:** https://github.com/testream/docs
 
-- 🎭 **Playwright Integration** - Works seamlessly with Playwright Test
-- 📊 **CTRF Format** - Generates standardized JSON test reports using `playwright-ctrf-json-reporter`
-- ☁️ **Automatic Upload** - Uploads test results and artifacts to your backend API
-- 📎 **Artifact Support** - Automatically uploads screenshots, videos, and traces
-- 🔄 **CI/CD Ready** - Auto-detects git context from GitHub Actions, GitLab CI, CircleCI, Jenkins
-- ⚙️ **Configurable** - Full control over report generation and upload behavior
-- 🛡️ **Error Handling** - Graceful failure modes with optional strict mode
-
-## Installation
+## Quick Start
 
 ```bash
 npm install --save-dev @testream/playwright-reporter
 ```
 
-## Configuration
-
-Add the reporter to your `playwright.config.ts`:
-
-```typescript
-import { defineConfig } from '@playwright/test';
-
-export default defineConfig({
-  reporter: [
-    ['list'], // Keep the default list reporter
-    [
-      '@testream/playwright-reporter',
-      {
-        // Required: API configuration
-        apiKey: process.env.TEST_MANAGER_API_KEY,
-        projectKey: 'PROJECT-1',
-
-        // Optional: Git context (auto-detected in CI environments)
-        branch: process.env.BRANCH_NAME,
-        commitSha: process.env.COMMIT_SHA,
-
-        // Optional: Upload behavior
-        uploadEnabled: true,
-        failOnUploadError: false,
-
-        // Optional: CTRF report options
-        outputFile: 'ctrf-report.json',
-        outputDir: 'ctrf',
-        screenshot: true,
-        annotations: false,
-        testType: 'e2e',
-
-        // Optional: Environment metadata
-        appName: 'My App',
-        appVersion: '1.0.0',
-        buildName: 'Build #123',
-        buildNumber: '123',
-        buildUrl: 'https://ci.example.com/build/123',
-        testEnvironment: 'staging',
-      },
-    ],
-  ],
-  // ... other config
-});
-```
-
-## Configuration Options
-
-### Required Options
-
-| Option | Type | Description |
-|--------|------|-------------|
-| `apiKey` | `string` | API key for authentication (store in environment variables) |
-| `projectKey` | `string` | Project key to associate test results with |
-
-### Optional Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `uploadEnabled` | `boolean` | `true` | Enable/disable automatic upload to backend |
-| `failOnUploadError` | `boolean` | `false` | Fail the test run if upload fails |
-| `branch` | `string` | Auto-detected | Git branch name |
-| `commitSha` | `string` | Auto-detected | Git commit SHA |
-| `outputFile` | `string` | `'ctrf-report.json'` | Local CTRF report filename |
-| `outputDir` | `string` | `'ctrf'` | Local CTRF report directory |
-| `screenshot` | `boolean` | `true` | Include screenshots in the report |
-| `annotations` | `boolean` | `false` | Include Playwright annotations |
-| `testType` | `string` | `'e2e'` | Test type (e.g., 'api', 'e2e', 'unit') |
-| `appName` | `string` | - | Application name under test |
-| `appVersion` | `string` | - | Application version under test |
-| `buildName` | `string` | - | Build name |
-| `buildNumber` | `string` | - | Build number |
-| `buildUrl` | `string` | - | Build URL |
-| `testEnvironment` | `string` | - | Test environment (e.g., 'staging', 'production') |
-
-## Usage
-
-### Basic Usage
-
-Once configured, the reporter automatically:
-1. Generates a CTRF report during test execution
-2. Uploads the report to your backend after tests complete
-3. Uploads any test artifacts (screenshots, videos, traces)
-
-```bash
-npx playwright test
-```
-
-### Capturing Screenshots
-
-To include screenshots in your reports, attach them in your tests:
-
-```typescript
-import { test, expect } from '@playwright/test';
-
-test('example test', async ({ page }, testInfo) => {
-  await page.goto('https://playwright.dev');
-  
-  // Capture screenshot
-  const screenshot = await page.screenshot({ 
-    quality: 50, 
-    type: 'jpeg' 
-  });
-  
-  await testInfo.attach('screenshot', {
-    body: screenshot,
-    contentType: 'image/jpeg',
-  });
-});
-```
-
-### Disable Upload for Local Development
-
-```typescript
+```ts
 // playwright.config.ts
-export default defineConfig({
-  reporter: [
-    [
-      '@testream/playwright-reporter',
-      {
-        apiKey: process.env.TEST_MANAGER_API_KEY,
-        projectKey: 'PROJECT-1',
-        uploadEnabled: process.env.CI === 'true', // Only upload in CI
-      },
-    ],
-  ],
-});
-```
-
-### Environment Variables
-
-It's recommended to store sensitive configuration in environment variables:
-
-```bash
-# .env
-TEST_MANAGER_API_KEY=your-api-key-here
-TEST_MANAGER_PROJECT_KEY=PROJECT-1
-```
-
-Then load them in your config:
-
-```typescript
 import { defineConfig } from '@playwright/test';
-import * as dotenv from 'dotenv';
-
-dotenv.config();
 
 export default defineConfig({
   reporter: [
-    [
-      '@testream/playwright-reporter',
-      {
-        apiKey: process.env.TEST_MANAGER_API_KEY,
-        projectKey: process.env.TEST_MANAGER_PROJECT_KEY,
-      },
-    ],
+    ['@testream/playwright-reporter', {
+      apiKey: process.env.TESTREAM_API_KEY,
+      projectKey: 'PROJ',
+      uploadEnabled: true,
+    }],
   ],
 });
 ```
 
-## CI/CD Integration
-
-### GitHub Actions
-
-The reporter automatically detects GitHub Actions environment variables:
-
-```yaml
-name: Playwright Tests
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Install Playwright Browsers
-        run: npx playwright install --with-deps
-      
-      - name: Run tests
-        run: npx playwright test
-        env:
-          TEST_MANAGER_API_KEY: ${{ secrets.TEST_MANAGER_API_KEY }}
-          TEST_MANAGER_API_URL: ${{ secrets.TEST_MANAGER_API_URL }}
-          TEST_MANAGER_PROJECT_KEY: 'PROJECT-1'
-```
-
-### GitLab CI
-
-```yaml
-test:
-  image: mcr.microsoft.com/playwright:latest
-  script:
-    - npm ci
-    - npx playwright test
-  variables:
-    TEST_MANAGER_API_KEY: $TEST_MANAGER_API_KEY
-    TEST_MANAGER_API_URL: $TEST_MANAGER_API_URL
-    TEST_MANAGER_PROJECT_KEY: "PROJECT-1"
-```
-
-### CircleCI
-
-```yaml
-version: 2.1
-jobs:
-  test:
-    docker:
-      - image: mcr.microsoft.com/playwright:latest
-    steps:
-      - checkout
-      - run: npm ci
-      - run: npx playwright test
-    environment:
-      TEST_MANAGER_API_KEY: $TEST_MANAGER_API_KEY
-      TEST_MANAGER_API_URL: $TEST_MANAGER_API_URL
-      TEST_MANAGER_PROJECT_KEY: "PROJECT-1"
-```
-
-## Troubleshooting
-
-### Upload Failures
-
-If uploads fail, the reporter logs detailed error messages but doesn't fail your tests by default:
-
-```
-❌ Failed to upload report: API ingest failed: HTTP 401: Unauthorized
-```
-
-To make upload failures fail the test run:
-
-```typescript
-{
-  failOnUploadError: true
-}
-```
-
-### Missing Artifacts
-
-Ensure artifacts are properly attached in tests and that file paths are accessible when the reporter runs.
-
-### Git Context Not Detected
-
-Manually specify branch and commit in configuration:
-
-```typescript
-{
-  branch: process.env.GIT_BRANCH || 'main',
-  commitSha: process.env.GIT_COMMIT || 'unknown',
-}
-```
-
-## How It Works
-
-1. **Test Execution**: Playwright runs your tests
-2. **CTRF Generation**: `playwright-ctrf-json-reporter` generates a CTRF-format JSON report
-3. **Report Upload**: Report is POSTed to `/api/v1/ingest` endpoint
-4. **Artifact Upload**: Each test attachment is uploaded to `/api/v1/artifacts/:reportId`
-5. **Linking**: Artifacts are linked to test results via test names
-
-## Related Packages
-
-- [playwright-ctrf-json-reporter](https://www.npmjs.com/package/playwright-ctrf-json-reporter) - Underlying CTRF reporter
-- [@testream/upload-action](https://www.npmjs.com/package/@testream/upload-action) - CLI and GitHub Action for uploading CTRF reports
-
-## License
-
-Proprietary - See LICENSE file
-
-## Support
-
-For issues and questions, contact your Jira Test Manager administrator.
+Need more configuration options? See the full guide at https://testream.github.io/docs/reporters/playwright.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@testream/playwright-reporter",
-  "version": "0.3.0",
-  "description": "Playwright CTRF reporter with automatic upload to Jira Test Management backend",
+  "version": "0.4.1",
+  "description": "Playwright CTRF reporter with automatic upload to Testream",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -14,7 +14,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/your-org/jira-test-manager.git"
+    "url": "git+https://github.com/testream/docs.git"
   },
   "keywords": [
     "playwright",
@@ -25,7 +25,7 @@
     "test-results",
     "jira"
   ],
-  "author": "Jira Test Manager Team",
+  "author": "Testream",
   "license": "SEE LICENSE IN LICENSE",
   "publishConfig": {
     "access": "public"