Add GHA workflow to compute code coverage via examples #10
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples | |
| # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help | |
| on: | |
| push: | |
| branches: [main, master] | |
| pull_request: | |
| branches: [main, master] | |
| name: test-coverage-examples | |
| jobs: | |
| test-coverage-examples: | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: r-lib/actions/setup-r@v2 | |
| with: | |
| use-public-rspm: true | |
| - uses: r-lib/actions/setup-r-dependencies@v2 | |
| with: | |
| extra-packages: | | |
| any::covr | |
| local::. | |
| - name: Test example coverage | |
| run: | | |
| options(crayon.enabled = TRUE) | |
| library(covr) | |
| files_to_exclude <- c( | |
| "R/actions.R", | |
| "R/cache.R", | |
| "R/deprecated.R", | |
| "R/namespace.R", | |
| "R/methods.R", | |
| "R/settings.R", | |
| "R/with.R", | |
| "R/with_id.R", | |
| "R/zzz.R" | |
| ) | |
| coverage <- covr::package_coverage( | |
| type = "examples", | |
| quiet = TRUE, | |
| commentDonttest = FALSE, | |
| commentDontrun = FALSE, | |
| line_exclusions = files_to_exclude | |
| ) | |
| print(coverage) | |
| percent_coverage <- covr::percent_coverage(coverage) | |
| threshold <- 90 | |
| cli::cli_rule() | |
| if (percent_coverage < threshold) { | |
| cli::cli_abort("Code coverage using examples is below the required threshold ({threshold}%).") | |
| } else { | |
| cli::cli_alert_success("Code coverage using examples is above the required threshold ({threshold}%).") | |
| } | |
| cli::cli_rule() | |
| shell: Rscript {0} |