Skip to content

docs(README): fix Markdown #58

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

Merged
merged 4 commits into from
Oct 16, 2020
Merged

docs(README): fix Markdown #58

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f73e68
docs(README): fix Markdown
MicaelJarniac Oct 13, 2020
7105c46
docs(README): fix indentation
MicaelJarniac Oct 13, 2020
28873e2
docs(README): fix URLs
MicaelJarniac Oct 16, 2020
3235bf2
docs(README): fix "Testing with Docker" URL
MicaelJarniac Oct 16, 2020
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
23 changes: 13 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ after_success:
```

### Produce Coverage Reports
`coverage.py <https://bitbucket.org/ned/coveragepy>`_ is required to collect coverage metrics.
[coverage.py](https://github.com/nedbat/coveragepy) is required to collect coverage metrics.

Below are some examples on how to include coverage tracking during your tests. Codecov will call `coveragexml -i` automatically to generate the coverage xml output, which will be archived and processed server side.

You may need to configure a ``.coveragerc`` file. Learn more `here <http://coverage.readthedocs.org/en/latest/config.html>`_. Start with this `generic .coveragerc <https://gist.github.com/codecov-io/bf15bde2c7db1a011b6e>`_ for example.
You may need to configure a `.coveragerc` file. Learn more [here](http://coverage.readthedocs.org/en/latest/config.html). Start with this [generic .coveragerc](https://gist.github.com/codecov-io/bf15bde2c7db1a011b6e) for example.

We highly suggest adding `source` to your ``.coveragerc`` which solves a number of issues collecting coverage.
We highly suggest adding `source` to your `.coveragerc` which solves a number of issues collecting coverage.

```ini
[run]
Expand All @@ -40,11 +40,11 @@ pytest --cov=./
```
nosetest --with-coverage
```
See the `Offical Nose coverage docs <http://nose.readthedocs.org/en/latest/plugins/cover.html>`_ for more information.
See the [Offical Nose coverage docs](http://nose.readthedocs.org/en/latest/plugins/cover.html) for more information.

### Testing with ``tox``

Codecov can be run from inside your ``tox.ini`` please make sure you pass all the necessary environment variables through:
Codecov can be run from inside your `tox.ini` please make sure you pass all the necessary environment variables through:
```ini
[testenv]
passenv = CI TRAVIS TRAVIS_*
Expand All @@ -53,12 +53,15 @@ commands = codecov
```

### FAQ
- Q: What's the difference between the codecov-bash and codecov-python uploader?<br/>A: As far as python is concerned, *nothing*. You may choose to use either uploader. Codecov recommends **using the bash uploader when possible** as it supports more unique repository setups. Learn more at `codecov/codecov-bash <https://github.com/codecov/codecov-bash>`_ and `codecov/codecov-python <https://github.com/codecov/codecov-python>`_.
- Q: Why am I seeing `No data to report`?<br/>A: This output is written by running the command ``coverage xml`` and states that there were no ``.coverage`` files found.
- Q: What's the difference between the codecov-bash and codecov-python uploader?
A: As far as python is concerned, *nothing*. You may choose to use either uploader. Codecov recommends **using the bash uploader when possible** as it supports more unique repository setups. Learn more at [codecov/codecov-bash](https://github.com/codecov/codecov-bash) and [codecov/codecov-python](https://github.com/codecov/codecov-python).
- Q: Why am I seeing `No data to report`?
A: This output is written by running the command `coverage xml` and states that there were no `.coverage` files found.
1. Make sure coverage is enabled. See Enabling Coverage
2. You may need to run `coverage combine` before running Codecov.
3. Using Docker? Please follow this step: `Testing with Docker: Codecov Inside Docker <https://github.com/codecov/support/wiki/Testing-with-Docker#codecov-inside-docker>`_.
- Q: Can I upload my ``.coverage`` files?<br/> A: **No**, these files contain coverage data but are not properly mapped back to the source code. We rely on ``coveragepy`` to handle this by calling ``coverage xml`` in the uploader.
3. Using Docker? Please follow this step: [Testing with Docker: Codecov Inside Docker](https://docs.codecov.io/docs/testing-with-docker#codecov-inside-docker).
- Q: Can I upload my `.coverage` files?
A: **No**, these files contain coverage data but are not properly mapped back to the source code. We rely on `coveragepy` to handle this by calling `coverage xml` in the uploader.

## Caveats
### Private Repo
Expand All @@ -75,4 +78,4 @@ Cobertura reports can expire - Codecov will reject reports that are older than 1


## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python?ref=badge_large)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python?ref=badge_large)