Replace codecov with python-coverage-comment-action (#1649)

Author: ewjoachim

.github/workflows/coverage.yml

@@ -0,0 +1,33 @@
+# .github/workflows/coverage.yml
+name: Post coverage comment
+
+on:
+  workflow_run:
+    workflows: ["Tests"]
+    types:
+      - completed
+
+jobs:
+  test:
+    name: Run tests & display coverage
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+      # Gives the action the necessary permissions for looking up the
+      # workflow that launched this workflow, and download the related
+      # artifact that contains the comment to be published
+      actions: read
+    steps:
+      # DO NOT run actions/checkout here, for security reasons
+      # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

.github/workflows/tests.yml

@@ -26,7 +26,7 @@ jobs:
           python -m pip install --upgrade pip setuptools
       - name: Install dependencies
         run: |
-          python -m pip install coverage tox tox-py unittest-xml-reporting
+          python -m pip install coverage[toml] tox tox-py unittest-xml-reporting
       - name: Run tox
         run: |
           python -m pip --version
@@ -35,12 +35,54 @@ jobs:
       - name: Coverage reporting
         run: |
           coverage combine
-          coverage report -m
-          coverage xml
-          coverage html
-      - name: Publish coverage results
-        uses: codecov/codecov-action@v4
+          coverage report --show-missing
+          mv .coverage .coverage.${{ matrix.python-version }}
+      - name: Store coverage file
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.python-version }}
+          path: .coverage.${{ matrix.python-version }}
+
+  coverage:
+    name: Coverage
+    runs-on: ubuntu-latest
+    needs: tests
+    permissions:
+      # If the author is a maintainer, the permission level is set by the
+      # values below.
+      # `pull-requests: write` is needed for publishing new comments in pull
+      # requests.
+      # `contents: write` is needed for pushing data to the
+      # `python-coverage-comment-action` branch, and for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      # In case the pull request comes from a forked repository, the maximum
+      # permission level is read, so the permissions below won't be acted upon
+      # by GitHub.
+      # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
 
+      - uses: actions/download-artifact@v4
+        id: download
+        with:
+          pattern: coverage-*
+          merge-multiple: true
+
+      - name: Coverage comment
+        id: coverage_comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MERGE_COVERAGE_FILES: true
+
+      - name: Store Pull Request comment to be posted
+        uses: actions/upload-artifact@v4
+        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+        with:
+          name: python-coverage-comment-action
+          path: python-coverage-comment-action.txt
 
   isort:
     runs-on: ubuntu-latest

README.rst

@@ -6,8 +6,8 @@ add dynamic ``QuerySet`` filtering from URL parameters.
 
 Full documentation on `read the docs`_.
 
-.. image:: https://codecov.io/gh/carltongibson/django-filter/branch/develop/graph/badge.svg
-    :target: https://codecov.io/gh/carltongibson/django-filter
+.. image:: https://raw.githubusercontent.com/carltongibson/django-filter/python-coverage-comment-action-data/badge.svg
+    :target: https://github.com/carltongibson/django-filter/tree/python-coverage-comment-action-data
 
 .. image:: https://badge.fury.io/py/django-filter.svg
     :target: http://badge.fury.io/py/django-filter

codecov.yml

@@ -54,3 +54,6 @@ known_first_party = ["django_filters"]
 
 [tool.flit.module]
 name = "django_filters"
+
+[tool.coverage.run]
+relative_files = true

pyproject.toml

@@ -1,6 +1,6 @@
 markdown
 django-crispy-forms
 
-coverage
+coverage[toml]
 pytz
 unittest-xml-reporting