Skip to content

Commit

Permalink
updated web usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danmayer committed Dec 20, 2018
1 parent f817ded commit d95c3d4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Build Status: [![Build Status](https://travis-ci.org/danmayer/coverband.svg?bran
<a href="#configuration">Configuration</a> •
<a href="#coverband-demo">Coverband Demo</a> •
<a href="#how-to-use">How To Use</a> •
<a href="#usage">Usage</a> •
<a href="#license">License</a> •
<a href="/changes.md">Change Log / Roadmap</a>
</p>
Expand Down Expand Up @@ -144,6 +143,23 @@ Below is my Coverband workflow, which hopefully will help other best use this li
* After Coverband has been verified to be working on production, I let it run for a few weeks.
* Then I view the report and start submitting PRs for the team to review delete large related sets of code that no longer are in use.

### Coverband Web Endpoint

The web endpoint is a barebones endpoint that you can either expose direct (after authentication) or you can just link to the actions you wish to expose. The index is intended as a example to showcase all the features.

![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web.png)
> The web index as available on the Coverband Demo site
* __collect data, update report, & view:__ This does everything need to view up to date Coverage
* it triggers a coverage collection on the current webserver process
* it generates a new html coverage report and pushes it to S3
* it then loads that report for you to view
* __view coverage report:__ Don't need to update the data just view the current report
* __update coverage data (collect coverage):__ This triggers coverage collection on the current webserver process
* __update coverage report (rebuild report):__ This will rebuild the HTML report from the latest available data
* __clear coverage report:__ This will clear the coverage data. This wipes out all collected data (__dangerous__)
* __reload Coverband files:__ This has Coverband reload files as configured (force reload of some files that might not capture Coverage on boot)

### Example apps

- [Rails 5.2.x App](https://github.com/danmayer/coverage_demo)
Expand Down
Binary file added docs/coverband_web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d95c3d4

Please sign in to comment.