Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update coveralls workflow to use lcov #210

Merged
merged 2 commits into from
Dec 18, 2023
Merged

Update coveralls workflow to use lcov #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc90480
Update coveralls workflow to use lcov
willu47 Dec 15, 2023
d9bccb5
Added note about coverage in contributing docs
willu47 Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/workflows/python.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,4 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'
run: |
pip install --upgrade coveralls
coveralls --service=github
uses: coverallsapp/github-action@v2
5 changes: 5 additions & 0 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,10 @@ Find more detailed information in `creating a PR`_. You might also want to open
the PR as a draft first and mark it as ready for review after the feedbacks
from the continuous integration (CI) system or any required fixes.

We track test coverage using coveralls_. You can check the coverage
of your PR by clicking on the "details" link in the "Coverage" section of
the pull request checks. Try to ensure that your pull requests always increase
test coverage.

Troubleshooting
---------------
Expand Down Expand Up @@ -281,6 +285,7 @@ on PyPI_, the following steps can be used to release a new version for
.. |tox| replace:: ``tox``


.. _coveralls: https://coveralls.io/github/OSeMOSYS/otoole
.. _black: https://pypi.org/project/black/
.. _CommonMark: https://commonmark.org/
.. _contribution-guide.org: https://www.contribution-guide.org/
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ console_scripts =
# CAUTION: --cov flags may prohibit setting breakpoints while debugging.
# Comment those flags to avoid this pytest issue.
addopts =
--cov otoole --cov-report html
--cov otoole --cov-report lcov
--verbose
-s
# --log-cli-level=10
Expand Down