See code coverage information from Codecov on GitHub, Sourcegraph, and other tools.
Branch: master
Clone or download
3askaal Merge pull request #21 from lguychard/upgrade-extension-api
Upgrade sourcegraph dependency to 20.1.0
Latest commit 22f4a1a Feb 11, 2019

README.md

Codecov Sourcegraph extension

A Sourcegraph extension for showing code coverage information from Codecov on GitHub, Sourcegraph, and other tools.

🎥 Demo video

🗃️ Source code

Add to Sourcegraph

Features

  • Support for GitHub.com and Sourcegraph.com
  • Line coverage overlays on files (with green/yellow/red background colors)
  • Line branches/hits annotations on files
  • File coverage ratio indicator (Coverage: N%) and toggle button
  • Support for using a Codecov API token to see coverage for private repositories

Usage

On GitHub using the Chrome extension

  1. Install Sourcegraph for Chrome or Sourcegraph for Firefox
  2. Enable the Codecov extension on Sourcegraph
  3. Visit tuf_store.go in theupdateframework/notary on GitHub (or any other file in a public repository that has Codecov code coverage)
  4. Click the Coverage: N% button to toggle Codecov test coverage background colors on the file (scroll down if they aren't immediately visible)

Screenshot

With private GitHub.com repositories

You can use the Codecov extension for private repositories on GitHub.com. Your code is never sent to Sourcegraph.

  1. Follow the Codecov extension usage instructions above to install Sourcegraph for Chrome/Firefox
  2. Go to the command palette on GitHub (added by the Sourcegraph browser extension, see screenshot below) and choose "Codecov: Set API token for private repositories"
  3. Enter your Codecov API token
  4. Visit any file in a GitHub.com private repository that has Codecov coverage data

image

Your code is never sent to Sourcegraph. The Codecov extension runs on the client side in a Web Worker and communicates with Codecov directly to retrieve code coverage data.

With Codecov Enterprise and GitHub Enterprise

You can use this extension to overlay coverage information from your Codecov Enterprise install into GitHub Enterprise.

  1. Follow the Codecov extension usage instructions above to install Sourcegraph for Chrome/Firefox
  2. From the command palette (added by the Sourcegraph browser extension, see screenshot above) on GitHub Enterprise click, "Codecov: Setup up Codecov Enterprise"
  3. From the pop up that appears, set your Version control type to: ghe
  4. From the next pop up that appears, set your Codecov endpoint, this is just the root level of your Codecov Enterprise domain, e.g., https://codecov.mycompany.com.
  5. Go to the command palette on GitHub and choose "Codecov: Set API token for private repositories"
  6. Enter your Codecov Enterprise API token.
  7. Visit any file in your Github Enterprise install with coverage data uploaded to Codecov Enterprise to see coverage data.

Note: Additional documentation, if needed, can be found in Codecov's official documentation.

On Sourcegraph.com

  1. Visit tuf_store.go in theupdateframework/notary on Sourcegraph.com (or any other file that has Codecov code coverage)
  2. Click the Coverage: N% button to toggle Codecov test coverage background colors on the file (sign-in required)

The Codecov extension is enabled by default on Sourcegraph.com, so you don't need to add it from its extension registry listing.

With a self-hosted Sourcegraph instance and the browser extension

If you're using a self-hosted Sourcegraph instance (not required), you need to explicitly enable Sourcegraph extensions.

  1. Open the Sourcegraph for Chrome/Firefox extension options page (by clicking the Sourcegraph icon in the browser toolbar)
  2. Check the box labeled Use Sourcegraph extensions