VeryGoodOpenSource/very_good_coverage
GitHub: VeryGoodOpenSource/very_good_coverage
Stars: 172 | Forks: 18
# Very Good Coverage
[][very_good_ventures_link_light]
[][very_good_ventures_link_dark]
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
[][ci_badge_link]
[][license_badge_link]
A GitHub Action which helps enforce a minimum code coverage threshold.
## Migration Guide
Migrate from `VeryGoodOpenSource/very_good_coverage` to [Very Good Workflows][very_good_workflows_link] by replacing your workflow step with the reusable workflow provided in that repository.
**Before:**
- name: Very Good Coverage
uses: VeryGoodOpenSource/very_good_coverage@v2
with:
path: '/coverage/lcov.info'
min_coverage: 95
exclude: '**/*_observer.dart **/change.dart'
**After:**
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/flutter_package.yml@v1
with:
min_coverage: 95
coverage_excludes: '**/*_observer.dart **/change.dart'
Refer to the [Very Good Workflows documentation][very_good_workflows_link] for the full list of available inputs and workflow options.
## Inputs
Very Good Coverage accepts the following configuration inputs:
| Input name | Description | Default value | Optional |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- |
| path | The absolute path to the lcov.info file. | `"/coverage/lcov.info"` | ✅ |
| min_coverage | The minimum coverage percentage allowed. Must be a number between 0 and 100. | `100` | ✅ |
| exclude | List of paths to exclude from the coverage report, separated by an empty space. Supports [globs]() to describe file patterns. | `""` | ✅ |
## Example usage
uses: VeryGoodOpenSource/very_good_coverage@v2
with:
path: '/coverage/lcov.info'
min_coverage: 95
exclude: '**/*_observer.dart **/change.dart'
## FAQs
#### How can I avoid Very Good Coverage reporting an empty or non-existent coverage file?
[Relevant issue](https://github.com/VeryGoodOpenSource/very_good_coverage/issues/167)
A failure for non-existent coverage file can be resolved by setting the path input to match the location of the already generated lcov file.
uses: VeryGoodOpenSource/very_good_coverage@v2
with:
path: 'my_project/coverage/lcov.info'
If your generated lcov file is empty this might be because you have no test files or your tests are not generating any coverage data.
If you wish to always bypass these warnings, we recommend using a conditional statement in your workflow to avoid running the Very Good Coverage action when the lcov file is empty or non-existent.
For example, if your non-existent or empty coverage file is meant to be located at `/coverage/lcov.info` you may do:
- name: Check for existing and non-empty coverage file
id: test_coverage_file
run: if [ -s "/coverage/lcov.info" ]; then echo "result=true" >> $GITHUB_OUTPUT ; else echo "result=false" >> $GITHUB_OUTPUT; fi
- name: Very Good Coverage
if: steps.test_coverage_file.outputs.result == 'true'
uses: VeryGoodOpenSource/very_good_coverage@v2
with:
path: '/coverage/lcov.info'
#### Why is my input path not relative to the specified `working-directory`?
[Relevant issue](https://github.com/VeryGoodOpenSource/very_good_coverage/issues/35)
The input path must be absolute. The specified working directory is ignored by the input path. This is because it is [not possible](https://github.com/actions/runner/issues/467) to access the working directory from an action. In other words, Very Good Coverage always runs from the root of your repository.
For example, if your working directory is `my_project` and your file is at `/my_project/coverage/lcov.info` you must do:
jobs:
build:
defaults:
run:
working-directory: my_project/
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Very Good Coverage
uses: VeryGoodOpenSource/very_good_coverage@v2
with:
path: /my_project/coverage/lcov.info
标签：自定义脚本