From 6214737bff8eb55c9196e5eb40f59be1f66ebab5 Mon Sep 17 00:00:00 2001 From: Spencer Murray Date: Mon, 28 Oct 2024 12:59:57 -0400 Subject: [PATCH 1/3] Update README.md with Safari instructions --- README.md | 51 +++++++++++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3b9170f..00b637d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Codecov Browser Extension for GitHub + [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-browser-extension.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-browser-extension?ref=badge_shield) [![Chrome Web Store](https://img.shields.io/chrome-web-store/v/gedikamndpbemklijjkncpnolildpbgo)](https://chrome.google.com/webstore/detail/codecov/gedikamndpbemklijjkncpnolildpbgo) @@ -9,55 +10,62 @@ ![Mozilla Add-on Users](https://img.shields.io/amo/users/%7Bf3924b0d-e29f-4593-b605-084b3d71ed9d%7D) ![Mozilla Add-on Rating](https://img.shields.io/amo/rating/%7Bf3924b0d-e29f-4593-b605-084b3d71ed9d%7D) - image -Automatically see code coverage data and line annotations while browsing files or reviewing pull requests in GitHub. +Automatically see code coverage data and line annotations while browsing files or reviewing pull requests in GitHub. ## Installing If you wish to simply use the extension, it is available as a [Firefox Add On](https://addons.mozilla.org/en-US/firefox/addon/codecov/) and a [Chrome Extension](https://chrome.google.com/webstore/detail/codecov/gedikamndpbemklijjkncpnolildpbgo). - -## About this extension +## About this extension The Codecov browser extension makes it easy to identify needed test areas by showing you absolute coverage and coverage changes overlaid with your code right in GitHub. -Once installed, get: - -* Line coverage information while viewing commits and single files -* Line coverage information and coverage totals on Pull Requests -* The ability to filter coverage using Flags and Components directly in the GitHub UI +Once installed, get: +- Line coverage information while viewing commits and single files +- Line coverage information and coverage totals on Pull Requests +- The ability to filter coverage using Flags and Components directly in the GitHub UI -Pre-requisites: +Pre-requisites: -* Must use either Firefox or Google Chrome web browsers. +- Must use either Firefox or Google Chrome web browsers. -How to enable: +How to enable: The extension uses your logged-in session to determine what private repos you have access to. Please make sure to log in to Codecov using your web browser to view coverage data for private repos in GitHub. ## Use with Self-Hosted and Dedicated Cloud Versions of Codecov + You can use this extension against installations of Codecov and GitHub that are: -* Self-hosted -* Part of Codecov's Dedicated Cloud plan +- Self-hosted +- Part of Codecov's Dedicated Cloud plan In order to do so you must provide: -* The URL of the Codecov installation -* The URL of your GitHub installation (even if that url is just https://github.com) -* [An API token for Codecov](https://docs.codecov.com/reference/overview) +- The URL of the Codecov installation +- The URL of your GitHub installation (even if that url is just https://github.com) +- [An API token for Codecov](https://docs.codecov.com/reference/overview) + +You can provide this information by using the Settings menu for the Extension in your browser. + +## Using the Safari extension -You can provide this information by using the Settings menu for the Extension in your browser. +We have published a Safari port of the extension, but it comes with the caveat that you _must_ use a Codecov API token for the extension to work. + +To use the extension with a cloud Codecov API token, follow the instructions above in [](#use-with-self-hosted-and-dedicated-cloud-versions-of-codecov), but generate the API token at [](https://app.codecov.io) and use the cloud urls for Codecov's API (`https://api.codecov.io`) and Github (`https://github.com`). Note that this also works on Chrome and Firefox, should you want to do that. + +We may fix this restriction in the future should the demand exist, but for now, this is just a low effort conversion provided as is. ## Running Locally + ```sh $ web-ext run -s dist -t chromium ``` -**Note**: You must be on GitHub's new UI for this extension to perform its magic. ✨ +**Note**: You must be on GitHub's new UI for this extension to perform its magic. ✨ As of today, GitHub will show you the old UI if not logged in (running in a temporary profile using web-ext). @@ -87,9 +95,8 @@ $ cp dist/manifest.firefox.json dist/manifest.json ## About Codecov -[Codecov](https://about.codecov.io) is the all-in-one code coverage reporting solution for any test suite - giving developers actionable insights to deploy reliable code with confidence. - - +[Codecov](https://about.codecov.io) is the all-in-one code coverage reporting solution for any test suite - giving developers actionable insights to deploy reliable code with confidence. ## License + [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-browser-extension.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fcodecov-browser-extension?ref=badge_large) From da9efac10b23d4d92cff5e48cd3f276e46f5bb26 Mon Sep 17 00:00:00 2001 From: Spencer Murray Date: Mon, 28 Oct 2024 13:08:44 -0400 Subject: [PATCH 2/3] Fix links --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 00b637d..e2a31b6 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ You can provide this information by using the Settings menu for the Extension in We have published a Safari port of the extension, but it comes with the caveat that you _must_ use a Codecov API token for the extension to work. -To use the extension with a cloud Codecov API token, follow the instructions above in [](#use-with-self-hosted-and-dedicated-cloud-versions-of-codecov), but generate the API token at [](https://app.codecov.io) and use the cloud urls for Codecov's API (`https://api.codecov.io`) and Github (`https://github.com`). Note that this also works on Chrome and Firefox, should you want to do that. +To use the extension with a cloud Codecov API token, follow the instructions above [here](#use-with-self-hosted-and-dedicated-cloud-versions-of-codecov), but generate the API token in [cloud Codecov](https://app.codecov.io) and use the cloud urls for Codecov's API (`https://api.codecov.io`) and Github (`https://github.com`). Note that this also works on Chrome and Firefox, should you want to do that. We may fix this restriction in the future should the demand exist, but for now, this is just a low effort conversion provided as is. From 83227c27bd1963378f14e3c496f87846019baca4 Mon Sep 17 00:00:00 2001 From: Spencer Murray Date: Mon, 28 Oct 2024 13:11:30 -0400 Subject: [PATCH 3/3] Fix link again --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e2a31b6..fcd0e18 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ You can provide this information by using the Settings menu for the Extension in We have published a Safari port of the extension, but it comes with the caveat that you _must_ use a Codecov API token for the extension to work. -To use the extension with a cloud Codecov API token, follow the instructions above [here](#use-with-self-hosted-and-dedicated-cloud-versions-of-codecov), but generate the API token in [cloud Codecov](https://app.codecov.io) and use the cloud urls for Codecov's API (`https://api.codecov.io`) and Github (`https://github.com`). Note that this also works on Chrome and Firefox, should you want to do that. +To use the extension with a cloud Codecov API token, follow the instructions [above](#use-with-self-hosted-and-dedicated-cloud-versions-of-codecov), but generate the API token in [cloud Codecov](https://app.codecov.io) and use the cloud urls for Codecov's API (`https://api.codecov.io`) and Github (`https://github.com`). Note that this also works on Chrome and Firefox, should you want to do that. We may fix this restriction in the future should the demand exist, but for now, this is just a low effort conversion provided as is.