Frequently Asked Questions
CI/CD
My company is switching git hosts. Will the coverage history cross over?
No, coverage history does not cross over. Although you will still be able to see the coverage history by logging into your Codecov account using the original git server account/login.
If our CI fails to upload a coverage report to Codecov will our CI builds fail?
No, Codecov will not fail any CI builds.
If I run parallel CI runs do I need to merge the coverage reports before uploading to Codecov?
No, Codecov will merge your coverage reports for you. After you run your test suites and generate your coverage reports, upload what you have and we’ll do the rest.
If I use multiple CI platforms, will Codecov still work with my repositories?
Yes. As long as you generate code coverage files and upload them in whatever CI platform you are running, Codecov will work.
Do I need a teambot and the GitHub app to set up the integration?
No. If you are using GitHub, using the GitHub app will be the only necessary step. If you are using GitLab or Bitbucket, only the teambot will be necessary. Instructions for these can be found here.
Getting Started
How do I enable the Sentry/Codecov integration?
Please check out our documentation here on getting the integration enabled: https://docs.sentry.io/product/codecov/
When I log in, I don’t see my organization’s private repositories. Why?
This typically happens if you have your scope set to “public” in which all private repositories will be hidden. To fix this, you can click “Add Private Scope” on your Organization “Repos” page. Once the page reloads, the repositories will resync and show up after that.
Can I ignore certain files/paths within my codebase that I do not wish to include in coverage metrics?
Yes. This is a configuration within the Codecov YAML file
What permissions or authentications do I need to do in order for Codecov to properly display for my developers?
Authentication is a 2-step process:
1. Your organization’s Codehost admin (GitHub, BitBucket, or GitLab) needs to authenticate Codecov for the organization
2. Each developer needs to create an account and authenticate Codecov for their account
Whenever I click on a link in the PR comment, I get a 404 page. Why?
This will happen for one of the following reasons:
1. You are not logged into Codecov.
2. You are not part of the Organization in GitHub
3. You ARE part of the organization in GitHub, but you are not an active member in Codecov (this can be fixed by visiting the “Members” tab within your Organization in Codecov and toggling the Activation Status next to your username)
How do I change the configuration on the repository?
Most Repo configuration is recorded in a file called codecov.yml within the Repo. The location of this configuration file may be anywhere within the Repo and must be named codecov.yml or .codecov.yml in order to be detected. Having configuration stored in the codecov.yml allows for complete transparency and version controlled configuration. For more details please see our configuration docs.
Codecov Plans
Do all of my Github users need access to Codecov?
Only PR Authors would need to have paid seats for Codecov, if a developer authors a PR and does not have a seat, instead of a Codecov report we would share a link to upgrade the amount of seats the organization has.
Does Codecov support self-hosted integrations?
In short: no. However, Codecov will be adding at least two additional platforms that will allow for things like on-prem code repositories, dedicated namespaces, VPN, IP whitelisting, and more.
Who can adjust billing/plans information?
The following can adjust team configuration:
- The User, if the account is their own profile
- A Codecov Team Admin
- The first User to create a billing account for the Team
- A User with admin status according to Service
Please contact Codecov staff if there are any discrepancies or issues with billing.
Note if you want to transfer administration to another User please (1) add the new User, (b) remove the old user in your Team account page.
Security
Is Codecov SOCII Certified?
Yes, you can see more information on our current security compliance status on our dedicated security page.
Does Codecov store my data?
Codecov DOES NOT store any source code. The only data we will store for you are the coverage reports uploaded to Codecov. The data in these files include paths, filenames, and coverage data (i.e. “line 1: covered, line 2: uncovered), but no source code.
If Codecov doesn't store my source code, why is it visible in the UI?
At display time, Codecov uses an OAuth access token token from your repository provider (e.g., GitHub, GitLab, BitBucket) to retrieve the code from the repository provider to display on the page with the coverage overlaid. The code is not stored anywhere and should the oauth2 token be revoked or access to the repo change, this page will not load and will instead show an error.
How does Codecov authorize access to a repository?
- Public Repos are visible to all Users and Guests
- Private Repos are visible to Users who have at least read access according to Service
- Codecov checks the User’s Scope by making an API request with the User’s Token
- If the User does not have at least read access to the Repo: Codecov will return a 404 HTTP Error
- Codecov always uses the acting User’s Token to make API requests to Service when navigating Codecov
- Codecov always uses the Bot’s Token when performing Worker tasks
Where can I see more information about Codecov’s Security Policy?
Codecov’s security policy can be found here.
Support
Where can I go to get help troubleshooting shooting issues?
Our support team would love to help! Please submit a ticket to support@codecov.io
We currently pay via credit card but want to switch to invoicing, how can I make this change?
You can submit a ticket here.
