readme

Author: nirtal85

.github/workflows/devRun.yml

@@ -2,16 +2,19 @@ name: Pre merge test
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [main]
     paths:
-      - '**/*.py'
-      - '**/*.toml'
-      - '**/*.lock'
-      - '.github/workflows/devRun.yml'
+      - "**/*.py"
+      - "**/*.toml"
+      - "**/*.lock"
+      - ".github/workflows/devRun.yml"
 
 permissions:
-  contents: write
+  contents: read
+  pull-requests: write
+  checks: write
   pages: write
+  id-token: write
 
 jobs:
   merge_test:
@@ -20,11 +23,12 @@ jobs:
     container:
       image: mcr.microsoft.com/playwright:v1.55.0
     steps:
-      - uses: actions/checkout@v5
+      - name: Checkout
+        uses: actions/checkout@v5
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.13'
+          python-version: "3.13"
       - name: Set up uv
         uses: astral-sh/setup-uv@v7
         with:
@@ -34,47 +38,60 @@ jobs:
           uv venv
           uv sync --all-extras --dev
       - name: Test with pytest
-        run:  xvfb-run .venv/bin/python -m pytest -m devRun --base-url ${{ vars.BASE_URL }}
+        run: xvfb-run .venv/bin/python -m pytest -m devRun --base-url ${{ vars.BASE_URL }}
       - name: Auto-assign reviewers
         uses: kentaro-m/auto-assign-action@v2.0.0
         if: success()
       - name: Store Playwright Traces and Videos From Failed Tests
         if: failure()
-        uses: actions/upload-artifact@v4.6.2
+        uses: actions/upload-artifact@v6
         id: artifact-upload-step
         with:
           name: test-results
           path: test-results/
           retention-days: 7
-      - name: Link Playwright Traces And Videos To Allure Report
+      - name: Link Playwright Traces And Videos To Allure Results
         working-directory: allure-results
         if: failure()
         run: echo ARTIFACT_URL=${{ steps.artifact-upload-step.outputs.artifact-url }} >> environment.properties
-      - name: Link Git Information And Browser Version To Allure Report
-        working-directory: allure-results
+      - name: Link Git Information And Browser Version To Allure Results
         if: always()
+        working-directory: allure-results
         run: |
           {
-           echo BUILD_URL=${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
-           echo GIT_BRANCH=${{ github.head_ref || github.ref_name }}
-           echo GIT_COMMIT_ID=${{ github.sha }}
-           echo GIT_COMMIT_MESSAGE=$(git show -s --format=%s HEAD)
-           echo GIT_COMMIT_AUTHOR_NAME=$(git show -s --format='%ae' HEAD)
-           echo GIT_COMMIT_TIME=$(git show -s --format=%ci HEAD)
-           echo CHROME_VERSION=$(google-chrome --product-version)
+            echo BUILD_URL=${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+            echo GIT_BRANCH=${{ github.head_ref || github.ref_name }}
+            echo GIT_COMMIT_ID=${{ github.sha }}
+            echo GIT_COMMIT_MESSAGE="$(git show -s --format=%s HEAD)"
+            echo GIT_COMMIT_AUTHOR_NAME="$(git show -s --format='%ae' HEAD)"
+            echo GIT_COMMIT_TIME="$(git show -s --format=%ci HEAD)"
+            echo CHROME_VERSION="$(google-chrome --product-version 2>/dev/null || true)"
           } >> environment.properties
-      - name: Generate Allure Report
-        uses: simple-elf/allure-report-action@v1.13
+      - name: Generate Allure report
+        if: always()
+        run: npx -y allure generate allure-results --output allure-report
+      - name: Allure PR summary
         if: always()
-        id: allure-report
+        uses: allure-framework/allure-action@v0.6.2
         with:
-          allure_results: allure-results
-          allure_report: allure-report
-          gh_pages: gh-pages
-          allure_history: allure-history
-      - name: Deploy Report To Github Pages
+          report-directory: "./allure-report"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload Pages artifact
         if: always()
-        uses: peaceiris/actions-gh-pages@v4
+        uses: actions/upload-pages-artifact@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: allure-history
+          path: allure-report
+  deploy_pages:
+    needs: merge_test
+    if: always()
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -126,21 +126,10 @@ pytest -m sanity
 
 ## 📊 Results, Traces & Debugging
 
-We use Allure for reporting and Playwright Traces for debugging.
-
-Viewing Reports Locally
-Windows (via Scoop):
-
-```bash
-scoop install allure
-allure serve allure-results
-```
-
-Mac (via Brew):
+We use Allure for reporting. To generate and open the report locally:
 
 ```bash
-brew install allure
-allure serve allure-results
+npx -y allure generate allure-results --output allure-report --open
 ```
 
 👉 [See a Live Example of the Report Here](https://nirtal85.github.io/Playwright-Python-Example/)