ci: make coverage PR comment sticky to avoid duplicates (fixes #34) (#35)

Co-authored-by: openhands <openhands@all-hands.dev>

Author: xingyaoww

.github/workflows/tests.yml

@@ -43,94 +43,13 @@ jobs:
         if: always()
         run: uv run coverage xml -i -o coverage.xml
 
-      - name: Code Coverage Summary
-        if: ${{ always() && hashFiles('coverage.xml') != '' }}
-        continue-on-error: true
-        uses: irongut/CodeCoverageSummary@v1.3.0
-        with:
-          filename: coverage.xml
-          badge: true
-          fail_below_min: false
-          format: markdown
-          hide_branch_rate: false
-          hide_complexity: true
-          indicators: true
-          output: both
-
-      - name: Add Coverage PR Comment
+      - name: Pytest coverage PR comment
         if: ${{ always() && github.event_name == 'pull_request' }}
         continue-on-error: true
-        uses: marocchino/sticky-pull-request-comment@v2
-        with:
-          recreate: true
-          path: code-coverage-results.md
-
-      - name: Upload coverage artifacts
-        if: always()
-        uses: actions/upload-artifact@v4
-        with:
-          name: coverage-artifacts
-          path: |
-            coverage.xml
-            code-coverage-results.md
-            docs/assets/coverage.svg
-          if-no-files-found: ignore
-      - name: Parse coverage percent
-        if: ${{ always() && github.event_name == 'pull_request' }}
-        id: parsecov
-        run: |
-          python - << 'PY'
-          import xml.etree.ElementTree as ET
-          import math
-          p = 'coverage.xml'
-          try:
-              root = ET.parse(p).getroot()
-              lr = root.attrib.get('line-rate')
-              pct = int(round(float(lr) * 100)) if lr is not None else 0
-          except Exception:
-              pct = 0
-          print(f"coverage_percent={pct}")
-          with open("coverage_percent.txt", "w") as f:
-              f.write(str(pct))
-          PY
-
-      - name: Determine badge color
-        if: ${{ always() && github.event_name == 'pull_request' }}
-        id: color
-        run: |
-          PCT=$(cat coverage_percent.txt || echo 0)
-          if [ "$PCT" -ge 90 ]; then COLOR=brightgreen; 
-          elif [ "$PCT" -ge 75 ]; then COLOR=green; 
-          elif [ "$PCT" -ge 60 ]; then COLOR=yellowgreen; 
-          elif [ "$PCT" -ge 50 ]; then COLOR=yellow; 
-          else COLOR=red; fi
-          echo "color=$COLOR" >> $GITHUB_OUTPUT
-          echo "pct=$PCT" >> $GITHUB_OUTPUT
-
-      - name: Ensure docs/assets directory
-        if: ${{ always() && github.event_name == 'pull_request' }}
-        run: mkdir -p docs/assets
-
-      - name: Generate coverage badge
-        if: ${{ always() && github.event_name == 'pull_request' }}
-        uses: emibcn/badge-action@v2.0.2
+        uses: MishaKav/pytest-coverage-comment@v1
         with:
-          label: coverage
-          status: "${{ steps.color.outputs.pct }}%"
-          color: "${{ steps.color.outputs.color }}"
-          path: docs/assets/coverage.svg
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          pytest-xml-coverage-path: coverage.xml
+          title: Coverage Report
+          create-new-comment: false
 
-      - name: Upload badge artifact (PRs)
-        if: ${{ always() && github.event_name == 'pull_request' }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: coverage-badge
-          path: docs/assets/coverage.svg
-
-      - name: Commit coverage badge (push builds on non-main branches)
-        if: ${{ always() && github.event_name == 'push' && github.ref != 'refs/heads/main' }}
-        uses: EndBug/add-and-commit@v9
-        with:
-          add: "docs/assets/coverage.svg"
-          message: "docs: update coverage badge [skip ci]"
-          default_author: github_actions

pyproject.toml

@@ -46,3 +46,17 @@ python_files = ["test_*.py"]
 python_classes = ["Test*"]
 python_functions = ["test_*"]
 addopts = "-v --tb=short"
+
+# Coverage.py configuration
+[tool.coverage.run]
+omit = [
+    "openhands/core/tests/*",
+    "openhands/tools/tests/*",
+]
+
+[tool.coverage.report]
+omit = [
+    "openhands/core/tests/*",
+    "openhands/tools/tests/*",
+]
+