From 29ddf2f1195e72831ece9b35730a54aff57f4b04 Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Tue, 2 Jan 2024 17:23:00 +0000 Subject: [PATCH] Include coverage stats for our projects (#163) --- .readthedocs.yml | 2 +- docs/guides/code-reviews.md | 23 +++++++++++++++++++++++ tox.ini | 2 +- 3 files changed, 25 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 3c55582..28fa8d8 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -11,7 +11,7 @@ build: python: "3.11" commands: - pip install --user tox - - python3 -m tox -e docs -- --strict --site-dir=_readthedocs/html/ + - python3 -m tox -e docs python: install: - method: pip diff --git a/docs/guides/code-reviews.md b/docs/guides/code-reviews.md index 7fd068e..b27753c 100644 --- a/docs/guides/code-reviews.md +++ b/docs/guides/code-reviews.md @@ -3,3 +3,26 @@ Whenever you are on reviewed or reviewer side, be gentle and be sure you read th 1. https://mtlynch.io/code-review-love/ 2. https://mtlynch.io/human-code-reviews-1/ 3. https://mtlynch.io/human-code-reviews-2/ + +## Coverage + +A thumb rule regarding code coverage is that any incoming change should not lower the current coverage level. Codecov is expected to prevent us from merging changes that will lower the coverage level. + +- [![codecov](https://codecov.io/github/ansible/ansible-lint/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-lint) ansible-lint + +- [![codecov](https://codecov.io/github/ansible/ansible-compat/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-compat) ansible-compat + +- [![codecov](https://codecov.io/github/ansible/ansible-navigator/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-navigator) ansible-navigator +- [![codecov](https://codecov.io/github/ansible/molecule/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/molecule) molecule + +- [![codecov](https://codecov.io/github/ansible/ansible-development-environment/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-development-environment) ansible-development-environment + +- [![codecov](https://codecov.io/github/ansible/ansible-creator/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-creator) ansible-creator + +- [![codecov](https://codecov.io/github/ansible/ansible-language-server/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-language-server) ansible-language-server + +- [![codecov](https://codecov.io/github/ansible/vscode-ansible/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/vscode-ansible) vscode-ansible + +- [![codecov](https://codecov.io/github/ansible/pytest-ansible/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/pytest-ansible) pytest-ansible + +- [![codecov](https://codecov.io/github/ansible/tox-ansible/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/tox-ansible) tox-ansible diff --git a/tox.ini b/tox.ini index 6dd10f5..ddf058c 100644 --- a/tox.ini +++ b/tox.ini @@ -22,7 +22,7 @@ passenv = * commands = ; ansible-playbook -i localhost, playbooks/sync.yml - mkdocs {posargs:build} --strict + mkdocs {posargs:build --strict --site-dir=_readthedocs/html/} skip_install = true usedevelop = false