@reportforge/playwright-pdf 0.24.0 → 0.25.0

package/README.md

@@ -220,7 +220,7 @@ Full reference: [reportforge.org/docs/configuration](https://reportforge.org/doc
 
 ### Live Runs
 
-Watch a run as it happens. With `live` enabled, the reporter prints an unguessable watch link (boxed under a `Live Tracker` heading) to your CI logs at run start and streams per-test progress to a hosted dashboard while tests execute. All shards of one CI run converge on a single live view. Each test shows its steps and assertions as sub-lines beneath its row: each step once, as it settles, indented under its parent `test.step` in source order (Playwright's hooks, fixtures, and teardown are filtered out). The PDF is still generated at the end, unchanged.
+Watch a run as it happens. With `live` enabled, the reporter prints an unguessable watch link (boxed under a `Live Tracker` heading) to your CI logs at run start and streams per-test progress to a hosted dashboard while tests execute. All shards of one CI run converge on a single live view. Tests are grouped by spec file and describe block into collapsible suites, failures first. While a test runs you see its steps settle live under the row; once it finishes, the row expands into the full step tree: your `test.step` names with the Playwright calls and assertions nested beneath them, and on failure the complete error message, code frame, and stack attached to the exact step that failed (Playwright's hooks, fixtures, and teardown are filtered out unless the failure happened inside one). The PDF is still generated at the end, unchanged.
 
 > The watch link is entitlement-gated. If you enable `live` but see no `Live Tracker` line, the reporter logs why (missing `RF_LICENSE_KEY`, or a cached token without the `live` entitlement; delete `~/.reportforge/license.json` to force re-activation).
 
@@ -239,13 +239,13 @@ reporter: [
 ],
 ```
 
-`steps: 'intent'` shows only your `test.step` names (plus any failing step): the cleanest, most readable trail. `'all'` adds every action and assertion beneath its parent step; `'failed'` (default) keeps intent + assertions + failures.
+`steps: 'intent'` shows only your `test.step` names (plus any failing step): the cleanest, most readable trail. `'all'` adds every action and assertion beneath its parent step; `'failed'` (default) keeps intent + assertions + failures. The mode shapes only the live trail while a test is still running; the full step tree a finished test expands into is always sent.
 
 Sharded runs need no extra config: every shard of one CI run converges on the same live view automatically. Set `RF_LIVE_RUN_ID` to override when your CI is not auto-detected.
 
 Live streaming is best-effort and entitlement-gated: if the server is unreachable the run is unaffected, and an active subscription with the `live` feature is required. If you've configured Slack/Teams/Discord notifications, the watch link is also posted to those channels when the run starts.
 
-> **Security:** the watch link exposes test titles + statuses (and step titles when `steps` is on) to anyone holding it — no login needed, which is the point: share it with whoever should watch. The token is scoped to that one run, and rotating your license key never breaks an already-shared link. Leaving `console: false` is recommended: enabling it streams your tests' stdout/stderr to anyone holding the link. Full details at [reportforge.org/docs/advanced/live](https://reportforge.org/docs/advanced/live).
+> **Security:** the watch link exposes test titles, statuses, step titles, and failure details (error messages, code frames, stacks) to anyone holding it — no login needed, which is the point: share it with whoever should watch. Your `redact` rules apply to everything on the link, error text included. The token is scoped to that one run, and rotating your license key never breaks an already-shared link. Leaving `console: false` is recommended: enabling it streams your tests' stdout/stderr to anyone holding the link. Full details at [reportforge.org/docs/advanced/live](https://reportforge.org/docs/advanced/live).
 
 ### Shard Merging
 

package/ci-templates/azure-devops/azure-pipelines.yml

@@ -1,58 +1,58 @@
-# Add this to your azure-pipelines.yml
-# Requires Node.js tool installed on the agent
-
-trigger:
-  branches:
-    include:
-      - main
-      - develop
-
-pr:
-  branches:
-    include:
-      - main
-
-pool:
-  vmImage: 'ubuntu-latest'
-
-variables:
-  - group: reportforge-secrets  # Variable group containing RF_LICENSE_KEY
-
-stages:
-  - stage: Test
-    displayName: 'Playwright Tests + PDF Report'
-    jobs:
-      - job: PlaywrightTest
-        displayName: 'Run Tests'
-        steps:
-          - task: NodeTool@0
-            displayName: 'Install Node.js'
-            inputs:
-              versionSpec: '22.x'
-
-          - script: npm ci
-            displayName: 'Install dependencies'
-
-          - script: npx playwright install chromium --with-deps
-            displayName: 'Install Playwright browsers'
-
-          - script: npx playwright test
-            displayName: 'Run Playwright tests'
-            env:
-              RF_LICENSE_KEY: $(RF_LICENSE_KEY)
-
-          - task: PublishPipelineArtifact@1
-            displayName: 'Upload PDF Report'
-            condition: always()
-            inputs:
-              targetPath: playwright-report
-              artifact: playwright-pdf-report
-              publishLocation: pipeline
-
-          - task: PublishTestResults@2
-            displayName: 'Publish Test Results'
-            condition: always()
-            inputs:
-              testResultsFormat: 'JUnit'
-              testResultsFiles: 'test-results/results.xml'
-              failTaskOnFailedTests: false
+# Add this to your azure-pipelines.yml
+# Requires Node.js tool installed on the agent
+
+trigger:
+  branches:
+    include:
+      - main
+      - develop
+
+pr:
+  branches:
+    include:
+      - main
+
+pool:
+  vmImage: 'ubuntu-latest'
+
+variables:
+  - group: reportforge-secrets  # Variable group containing RF_LICENSE_KEY
+
+stages:
+  - stage: Test
+    displayName: 'Playwright Tests + PDF Report'
+    jobs:
+      - job: PlaywrightTest
+        displayName: 'Run Tests'
+        steps:
+          - task: NodeTool@0
+            displayName: 'Install Node.js'
+            inputs:
+              versionSpec: '22.x'
+
+          - script: npm ci
+            displayName: 'Install dependencies'
+
+          - script: npx playwright install chromium --with-deps
+            displayName: 'Install Playwright browsers'
+
+          - script: npx playwright test
+            displayName: 'Run Playwright tests'
+            env:
+              RF_LICENSE_KEY: $(RF_LICENSE_KEY)
+
+          - task: PublishPipelineArtifact@1
+            displayName: 'Upload PDF Report'
+            condition: always()
+            inputs:
+              targetPath: playwright-report
+              artifact: playwright-pdf-report
+              publishLocation: pipeline
+
+          - task: PublishTestResults@2
+            displayName: 'Publish Test Results'
+            condition: always()
+            inputs:
+              testResultsFormat: 'JUnit'
+              testResultsFiles: 'test-results/results.xml'
+              failTaskOnFailedTests: false

package/ci-templates/github-actions/basic-workflow.yml

@@ -1,44 +1,44 @@
-# Copy this file to .github/workflows/playwright.yml in your project
-name: Playwright Tests + PDF Report
-
-on:
-  push:
-    branches: [main, develop]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          cache: 'npm'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Install Playwright browsers
-        run: npx playwright install chromium --with-deps
-
-      - name: Run Playwright tests
-        run: npx playwright test
-        env:
-          RF_LICENSE_KEY: ${{ secrets.RF_LICENSE_KEY }}
-
-      - name: Upload PDF Report
-        if: always()
-        uses: actions/upload-artifact@v4
-        with:
-          name: playwright-pdf-report
-          path: playwright-report/*.pdf
-          retention-days: 30
-
-      - name: Comment PR
-        if: always() && github.event_name == 'pull_request'
-        uses: ./.github/actions/playwright-pdf-report
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+# Copy this file to .github/workflows/playwright.yml in your project
+name: Playwright Tests + PDF Report
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install Playwright browsers
+        run: npx playwright install chromium --with-deps
+
+      - name: Run Playwright tests
+        run: npx playwright test
+        env:
+          RF_LICENSE_KEY: ${{ secrets.RF_LICENSE_KEY }}
+
+      - name: Upload PDF Report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: playwright-pdf-report
+          path: playwright-report/*.pdf
+          retention-days: 30
+
+      - name: Comment PR
+        if: always() && github.event_name == 'pull_request'
+        uses: ./.github/actions/playwright-pdf-report
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/ci-templates/gitlab-ci/.gitlab-ci.yml

@@ -1,42 +1,42 @@
-# Add this job to your .gitlab-ci.yml
-# Uses the official Playwright Docker image which includes Chromium
-
-variables:
-  RF_LICENSE_KEY: $REPORTFORGE_LICENSE  # Set in GitLab CI/CD Settings > Variables
-
-playwright-tests:
-  image: mcr.microsoft.com/playwright:v1.49.0-jammy
-  stage: test
-  script:
-    - npm ci
-    - npx playwright test
-  artifacts:
-    name: "playwright-pdf-${CI_COMMIT_SHORT_SHA}"
-    paths:
-      - playwright-report/*.pdf
-    expire_in: 30 days
-    when: always
-    expose_as: 'Playwright PDF Report'
-  variables:
-    PUPPETEER_EXECUTABLE_PATH: /usr/bin/chromium-browser
-  rules:
-    - if: $CI_MERGE_REQUEST_ID
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-
-# Optional: Post merge request note with report link
-notify-mr:
-  stage: .post
-  image: alpine:latest
-  script:
-    - |
-      if [ -n "$CI_MERGE_REQUEST_IID" ]; then
-        curl -s --request POST \
-          --header "PRIVATE-TOKEN: $CI_API_TOKEN" \
-          --header "Content-Type: application/json" \
-          --data "{\"body\": \"📄 Playwright PDF report available: [Download](${CI_JOB_URL}/artifacts/download)\"}" \
-          "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests/${CI_MERGE_REQUEST_IID}/notes"
-      fi
-  rules:
-    - if: $CI_MERGE_REQUEST_ID
-      when: always
-  needs: [playwright-tests]
+# Add this job to your .gitlab-ci.yml
+# Uses the official Playwright Docker image which includes Chromium
+
+variables:
+  RF_LICENSE_KEY: $REPORTFORGE_LICENSE  # Set in GitLab CI/CD Settings > Variables
+
+playwright-tests:
+  image: mcr.microsoft.com/playwright:v1.49.0-jammy
+  stage: test
+  script:
+    - npm ci
+    - npx playwright test
+  artifacts:
+    name: "playwright-pdf-${CI_COMMIT_SHORT_SHA}"
+    paths:
+      - playwright-report/*.pdf
+    expire_in: 30 days
+    when: always
+    expose_as: 'Playwright PDF Report'
+  variables:
+    PUPPETEER_EXECUTABLE_PATH: /usr/bin/chromium-browser
+  rules:
+    - if: $CI_MERGE_REQUEST_ID
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+# Optional: Post merge request note with report link
+notify-mr:
+  stage: .post
+  image: alpine:latest
+  script:
+    - |
+      if [ -n "$CI_MERGE_REQUEST_IID" ]; then
+        curl -s --request POST \
+          --header "PRIVATE-TOKEN: $CI_API_TOKEN" \
+          --header "Content-Type: application/json" \
+          --data "{\"body\": \"📄 Playwright PDF report available: [Download](${CI_JOB_URL}/artifacts/download)\"}" \
+          "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests/${CI_MERGE_REQUEST_IID}/notes"
+      fi
+  rules:
+    - if: $CI_MERGE_REQUEST_ID
+      when: always
+  needs: [playwright-tests]

package/ci-templates/jenkins/Jenkinsfile

@@ -1,54 +1,54 @@
-// Add this stage to your existing Jenkinsfile
-// Requires: Node.js tool configured, Chrome/Chromium installed on agent
-
-pipeline {
-    agent { label 'linux' }
-
-    environment {
-        RF_LICENSE_KEY = credentials('reportforge-license-key')
-    }
-
-    stages {
-        stage('Install') {
-            steps {
-                sh 'npm ci'
-                sh 'npx playwright install chromium'
-            }
-        }
-
-        stage('Playwright Tests + PDF Report') {
-            steps {
-                sh 'npx playwright test'
-            }
-            post {
-                always {
-                    // Archive the PDF report as a build artifact
-                    archiveArtifacts(
-                        artifacts: 'playwright-report/*.pdf',
-                        allowEmptyArchive: true,
-                        fingerprint: true
-                    )
-                    // Publish HTML alongside (optional)
-                    publishHTML(target: [
-                        allowMissing: true,
-                        alwaysLinkToLastBuild: true,
-                        keepAll: true,
-                        reportDir: 'playwright-report',
-                        reportFiles: '*.pdf',
-                        reportName: 'Playwright PDF Report'
-                    ])
-                }
-            }
-        }
-    }
-
-    post {
-        failure {
-            emailext(
-                subject: "FAILED: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
-                body: "Build failed. PDF report: ${env.BUILD_URL}artifact/playwright-report/",
-                recipientProviders: [[$class: 'DevelopersRecipientProvider']]
-            )
-        }
-    }
-}
+// Add this stage to your existing Jenkinsfile
+// Requires: Node.js tool configured, Chrome/Chromium installed on agent
+
+pipeline {
+    agent { label 'linux' }
+
+    environment {
+        RF_LICENSE_KEY = credentials('reportforge-license-key')
+    }
+
+    stages {
+        stage('Install') {
+            steps {
+                sh 'npm ci'
+                sh 'npx playwright install chromium'
+            }
+        }
+
+        stage('Playwright Tests + PDF Report') {
+            steps {
+                sh 'npx playwright test'
+            }
+            post {
+                always {
+                    // Archive the PDF report as a build artifact
+                    archiveArtifacts(
+                        artifacts: 'playwright-report/*.pdf',
+                        allowEmptyArchive: true,
+                        fingerprint: true
+                    )
+                    // Publish HTML alongside (optional)
+                    publishHTML(target: [
+                        allowMissing: true,
+                        alwaysLinkToLastBuild: true,
+                        keepAll: true,
+                        reportDir: 'playwright-report',
+                        reportFiles: '*.pdf',
+                        reportName: 'Playwright PDF Report'
+                    ])
+                }
+            }
+        }
+    }
+
+    post {
+        failure {
+            emailext(
+                subject: "FAILED: ${env.JOB_NAME} #${env.BUILD_NUMBER}",
+                body: "Build failed. PDF report: ${env.BUILD_URL}artifact/playwright-report/",
+                recipientProviders: [[$class: 'DevelopersRecipientProvider']]
+            )
+        }
+    }
+}