Skip to content

Commit

Permalink
revert readme change
Browse files Browse the repository at this point in the history
  • Loading branch information
devoncarew committed Oct 14, 2024
1 parent e2377d2 commit 36c6b7c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions pkgs/firehose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ This is a Github workflow to check PR health.

When run from a PR, this tool will check a configurable subset of the following

* The package versioning is correct and consistent, see `firehose` description above.
* A changelog entry has been added.
* All `.dart` files have a license header.
* How the test coverage is affected by the PR.
Expand All @@ -186,8 +187,8 @@ jobs:
uses: dart-lang/ecosystem/.github/workflows/health.yaml@main
# with:
# sdk: beta
# checks: "changelog,license,coverage,breaking,do-not-submit,leaking"
# fail_on: "changelog,do-not-submit"
# checks: "version,changelog,license,coverage,breaking,do-not-submit,leaking"
# fail_on: "version,changelog,do-not-submit"
# warn_on: "license,coverage,breaking,leaking"
# coverage_web: false
# upload_coverage: false
Expand Down Expand Up @@ -228,8 +229,8 @@ jobs:

| Name | Type | Description | Example |
| ------------- | ------------- | ------------- | ------------- |
| checks | List of strings | What to check for in the PR health check | `"changelog,license,coverage,breaking,do-not-submit,leaking"` |
| fail_on | List of strings | Which checks should lead to failure | `"changelog,do-not-submit"` |
| checks | List of strings | What to check for in the PR health check | `"version,changelog,license,coverage,breaking,do-not-submit,leaking"` |
| fail_on | List of strings | Which checks should lead to failure | `"version,changelog,do-not-submit"` |
| warn_on | List of strings | Which checks should not fail, but only warn | `"license,coverage,breaking,leaking"` |
| upload_coverage | boolean | Whether to upload the coverage to [coveralls](https://coveralls.io/) | `true` |
| coverage_web | boolean | Whether to run `dart test -p chrome` for coverage | `false` |
Expand Down

0 comments on commit 36c6b7c

Please sign in to comment.