Conditionally run only one code coverage message

[ReinderVosDeWael]

Post-hoc task-list:

• If secrets.CODECOV_TOKEN is available, run CODECOV_TOKEN
• If not, run Github-based coverage comment.

---

Original post

Currently, PRs provide two code coverage messages; one by Github, one by CodeCov (e.g. #31). This seems unnecessary.

I suggest we remove the Github message, as our coverage badge relies on CodeCov. That being said, if there is a way to generate a code coverage badge through Github, I'd be in favor of cutting the number of services we need.

[ReinderVosDeWael]

One important point brought up by @nx10 is that the Github comment is available to private repositories whereas CodeCov is not. So ideally we'd conditionally run one or the other depending on whether the CODECOV_TOKEN is available.

[nx10]

Do public repos need CODECOV_TOKEN? Otherwise I would say

if private and not CODECOV_TOKEN:
run_github()
else:
run_codecov()

[ReinderVosDeWael]

They do need the token, yes. I tried it with this, as well as a few variants, but it kept running the github coverage despite the if-statement

- name: Pytest coverage comment
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        if: github.event_name == 'pull_request' && ${{ env.CODECOV_TOKEN == '' }}
        uses: MishaKav/pytest-coverage-comment@main
        with:
          pytest-coverage-path: ./pytest-coverage.txt
          junitxml-path: ./pytest.xml

[ReinderVosDeWael]

@nx10 I'd be happy marking this one as a 'not worth investing the time into' and closing it. Would you agree?

[nx10]

Sure, i also prefer the simple codecov comment to the codecov one for a quick glance anyway