Skip to content

Commit

Permalink
Update build-tools/packages/build-cli/docs/codeCoverageDetails.md
Browse files Browse the repository at this point in the history
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
  • Loading branch information
jatgarg and tylerbutler authored Oct 4, 2024
1 parent e50a24d commit 4b6c1e1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion build-tools/packages/build-cli/docs/codeCoverageDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Before running coverage comparison, a baseline build needs to be determined for

### Downloading artifacts from baseline build

Once the baseline build is identified, we download the build artifacts corresponding to the `Code Coverage Report_{Build_Number}` artifact name for this build. We unzip the files, and extract the coverage metrics out of the coverage reports using the helper `getCoverageMetricsFromArtifact`. Currently, we track `lineCoverage` and `branchCoverage` as our metrics for reporting but only use `branchCoverage` for success criteria. The final structure of the extracted metrics looks like
Once the baseline build is identified, we download the build artifacts corresponding to the `Code Coverage Report_{Build_Number}` artifact name for this build. We unzip the files and extract the coverage metrics out of the coverage reports using the helper `getCoverageMetricsFromArtifact`. Currently, we track `lineCoverage` and `branchCoverage` as our metrics for reporting but only use `branchCoverage` for success criteria. The final structure of the extracted metrics looks like the following:

```typescript
/**
Expand Down

0 comments on commit 4b6c1e1

Please sign in to comment.