Fix coverage workflow

[kratman]

Description

Coverage was not working properly, this should fix it

Type of change

• Bug fix (non-breaking change which fixes an issue)

Key checklist:

• No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
• All tests pass: $ python run-tests.py --all (or $ nox -s tests)
• The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[agriyakhetarpal]

Suggestion: we should move the coverage upload step above the integration tests, since the coverage is just for the unit tests anyway – CodeCov will then analyse the coverage and return its results earlier

[agriyakhetarpal]

The notebook failure is sporadic and unrelated, should be fixed with a rerun

[agriyakhetarpal]

Another proposition: the macos-14 images are much faster than the ubuntu-latest runners (~9 minutes vs ~25 minutes), so PyBOP had switched to using them for coverage – maybe we can try that as well? As far as I know, there is just one LaTeX test that needs to run on Linux, we can skip it on macOS to get faster coverage.

[kratman]

Another proposition: the macos-14 images are much faster than the ubuntu-latest runners (~9 minutes vs ~25 minutes), so PyBOP had switched to using them for coverage – maybe we can try that as well? As far as I know, there is just one LaTeX test that needs to run on Linux, we can skip it on macOS to get faster coverage.

For now, lets leave it. Especially if it requires skipping some coverage tests

[agriyakhetarpal]

The coverage upload failed silently again, maybe we need to supply GHA's special ${{ secrets.GITHUB_TOKEN }} with it in an input for it to work?

[kratman]

error - 2024-06-06 16:52:39,048 -- Upload failed: {"detail":"Tokenless has reached GitHub rate limit. Please upload using a token: https://docs.codecov.com/docs/adding-the-codecov-token. Expected available in 103 seconds."}

[agriyakhetarpal]

I think someone with admin permissions will have to add a secret to the repository, then – tagging @pybamm-team/maintainers

[kratman]

I think someone with admin permissions will have to add a secret to the repository

codecov/codecov-action#1471

I think it an issue with codecov because I am using a fork for my branch

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (f3f7b4c) to head (68bfa6e).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4146   +/-   ##
========================================
  Coverage    99.55%   99.55%           
========================================
  Files          288      288           
  Lines        21790    21790           
========================================
  Hits         21693    21693           
  Misses          97       97           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kratman]

Works now, sporadic failures will happen until the codecov fixes a bug