Skip to content

Commit cc0ec22

Browse files
committed
doc: update README
1 parent 3dcd7b6 commit cc0ec22

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ This GitHub Action (written in JavaScript) allows you to leverage GitHub Actions
55
- Commenting on a pull request (if the workflow was triggered by this event)
66
- Failing if a minimum coverage is not met
77

8+
Based on the code from [zgosalvez/github-actions-report-lcov](https://github.com/zgosalvez/github-actions-report-lcov).
9+
810
## Usage
911
### Pre-requisites
1012
Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#common-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
@@ -46,7 +48,7 @@ jobs:
4648
- name: Setup LCOV
4749
uses: hrishikesh-kadam/setup-lcov@v1
4850
- name: Report code coverage
49-
uses: zgosalvez/github-actions-report-lcov@v3
51+
uses: mbta/github-actions-report-lcov@v4
5052
with:
5153
coverage-files: coverage/lcov.*.info
5254
minimum-coverage: 90
@@ -55,11 +57,13 @@ jobs:
5557
working-directory: apps/my-first-app
5658
update-comment: true
5759
```
58-
*Note:* Only the `pull_request` and `pull_request_target` events are supported. This action does nothing when triggered by other event types.
60+
*Note:* Only the following events are supported:
5961
60-
### Flutter Workflows
62+
- `pull_request`
63+
- `pull_request_target`
64+
- `workflow_run` (when triggered by a PR)
6165

62-
This is used in my opinionated [GitHub Actions: Flutter Workflows](https://github.com/zgosalvez/github-actions-flutter-workflows) repository along with other actions for a complete end-to-end DevOps experience.
66+
This action does nothing when triggered by other event types.
6367

6468
## License
6569
The scripts and documentation in this project are released under the [MIT License](LICENSE.md)

0 commit comments

Comments
 (0)