devgony/Badgers PR Coverage
PR line coverage reports for Python and Flutter projects with diff annotations, comments, and durable history.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| cli-version | Badgers CLI release to install. 'auto' uses the release matching a versioned Action ref and falls back to a source build for main or SHAs; use 'latest', an exact vX.Y.Z tag, or 'source' to override that behavior. | — | auto |
| working-directory | Directory containing the project (repo-relative) | — | . |
| language | Coverage collector to use. 'python' reads coverage.py data; 'flutter' reads the coverage/lcov.info written by "flutter test --coverage". | — | python |
| coverage-command | Command that runs the test suite under coverage (e.g. "python -m coverage run -m unittest discover" or "flutter test --coverage"). Also executed at the merge-base checkout to build the PR baseline. | yes | — |
| pages | Deploy the HTML report to GitHub Pages (gh-pages branch) | — | false |
| gcs-bucket | GCS bucket for snapshot history (baselines without re-running tests). Requires google-github-actions/auth to run first in the calling workflow. Empty disables GCS. | — | "" |
| gcs-prefix | Object key prefix inside the GCS bucket | — | badgers |
| pr-comment | Post/update a coverage summary comment on the PR (marker-based upsert). Requires `pull-requests: write`; posting failures only warn. | — | true |
| check-annotations | Publish warning annotations for uncovered changed executable lines. Requires `checks: write`; publishing failures only warn. | — | true |
| fail-on-uncovered | Fail after publishing reports when changed executable lines remain uncovered in a pull request. | — | false |
| markdown-summary | Publish a navigable Markdown coverage report to the job summary. | — | false |
| github-storage-repo | GitHub repository used for durable reports and baseline snapshots (owner/repo). Empty disables repository storage. | — | "" |
| github-storage-branch | Dedicated branch used in the storage repository | — | badgers-coverage |
| github-storage-prefix | Path prefix inside the storage repository | — | badgers |
| github-storage-token | Contents-write token for the storage repository. The default token only works when github-storage-repo is the current repository; use a GitHub App installation token or fine-grained PAT for another repository. | — | ${{ github.token }} |
| github-storage-retention | Retention policy for commits/{sha} directories in the storage branch. 'latest' (default) prunes commits not referenced by any pointer after each push. 'all' skips pruning and keeps full history. | — | latest |
| pages-branch | Branch used for GitHub Pages deployment | — | gh-pages |
| github-token | Token used to push the Pages branch and enable Pages | — | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| report-url | URL of the deployed HTML report (empty unless pages=true) |
| durable-report-url | URL of the durable Markdown PR report (empty for disabled storage, non-PR runs, and forks) |