Advanced Usage

# .github/workflows/playwright.yml
name: Playwright Tests
on:
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]
jobs:
  test:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-node@v4
      with:
        node-version: lts/*
    - name: Install dependencies
      run: npm ci
    - name: Install Playwright Browsers
      run: npx playwright install --with-deps
    - name: Run Playwright tests
      run: npm run test
    - uses: actions/upload-artifact@v4
      if: always()
      with:
        name: playwright-report
        path: playwright-report/
        retention-days: 30Copy

# .gitlab-ci.yml
stages:
  - test

tests:
  # Using the official Playwright image is the equivalent of "runs-on: ubuntu" + "setup-node" + "install browsers"
  # Replace 'v1.48.0' with the version matching your package.json
  image: mcr.microsoft.com/playwright:v1.48.0-jammy
  
  stage: test
  timeout: 1h  # Matches "timeout-minutes: 60"
  
  # Cache node_modules to speed up runs (optional but recommended)
  cache:
    key: $CI_COMMIT_REF_SLUG
    paths:
      - node_modules/

  script:
    - npm ci
    - npx playwright install --with-deps # Ensures specific browser versions needed are present
    - npm run test

  artifacts:
    when: always  # Matches "if: always()"
    paths:
      - playwright-report/
    expire_in: 30 days # Matches "retention-days: 30"

  # Logic to trigger on branches main/master and Merge Requests
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
    - if: $CI_COMMIT_BRANCH == 'main'
    - if: $CI_COMMIT_BRANCH == 'master'Copy

// Jenkinsfile
pipeline {
    agent {
        // Equivalent to "runs-on: ubuntu-latest" with setup-node pre-applied
        docker {
            image 'mcr.microsoft.com/playwright:v1.48.0-jammy' 
            // 'reuseNode true' ensures the workspace is preserved
            args '-u root' 
        }
    }

    options {
        // Matches "timeout-minutes: 60"
        timeout(time: 60, unit: 'MINUTES')
    }

    triggers {
        // Jenkins usually relies on Webhooks for PRs/Pushes, 
        // but this enables polling if you don't have hooks setup.
        pollSCM('*/5 * * * *') 
    }

    stages {
        stage('Install Dependencies') {
            steps {
                sh 'npm ci'
            }
        }

        stage('Install Playwright Browsers') {
            steps {
                sh 'npx playwright install --with-deps'
            }
        }

        stage('Run Tests') {
            steps {
                // Matches "npm run test"
                sh 'npm run test'
            }
        }
    }

    post {
        always {
            // Matches "if: always()" + artifact upload
            // The allowEmptyArchive prevents failure if the report wasn't generated
            archiveArtifacts artifacts: 'playwright-report/**', allowEmptyArchive: true, fingerprint: true
        }
    }
}Copy

npx playwright test test1.spec.ts && npx playwright test test2.spec.tsCopy

# playwright.config.ts


import { defineConfig } from "@playwright/test";
import * as path from "path";
              
// Define where the final report JSON and HTML should go
const PULSE_REPORT_DIR = path.resolve(__dirname, "pulse-report"); // Example: a directory in your project root
              
export default defineConfig({
  reporter: [
    ["list"],
    [
      "@arghajit/playwright-pulse-report",
      {
        outputDir: PULSE_REPORT_DIR,
        // Add this option
        resetOnEachRun: false, // Default is true
      },
    ],
  ],
  // ...
});Copy

// example.spec.ts/js file

import { pulse } from "@arghajit/playwright-pulse-report"; // Add this import statement in the test file


test("test case name", async ({ page }) => {
  pulse.severity("High"); // Add this line before the test case
  // Add your test case code here
});Copy