Package 'covr2gh'

Compose a coverage comment

Description

Compose a coverage comment

Usage

compose_comment(
  head_coverage,
  base_coverage,
  repo,
  pr_number,
  diff_cov_target = NULL
)

Arguments

head_coverage	(coverage) active / current branch (HEAD) coverage. The output of covr::package_coverage() on the head branch.
base_coverage	(coverage) base / target branch coverage (coverage for the branch merging into). The output of covr::package_coverage() on the base branch.
repo	(character) the repository name in the GitHub format ("OWNER/REPO").
pr_number	(integer) the PR number
diff_cov_target	(numeric) minimum accepted diff coverage. Defaults to NULL which is then interpreted as overall base branch coverage.

Value

a character scalar with the content of the GitHub comment

Examples

## Not run: 
coverage_head <- covr::package_coverage()
system("git checkout main")
coverage_main <- covr::package_coverage()

compose_comment(
  head_coverage = coverage_head,
  base_coverage = coverage_main,
  repo = "<owner>/<repo>",
  pr_number = 3
)

## End(Not run)

---

Generate a coverage badge

Description

Generate a coverage badge

Usage

generate_badge(value)

Arguments

value

(a numeric scalar) percentage coverage.

Value

a SVG string invisibly

Examples

generate_badge(5)
generate_badge(48)

---

Post comment

Description

post_comment() first checks if a "known" covr2gh comment exists on the target pull request. If it does, then it updates it, if it doesn't, then a a new comment is posted.

Usage

post_comment(body, repo, pr_number, update = TRUE)

Arguments

body	(character scalar) the content of the body of the message.
repo	(character) the repository name in the GitHub format ("OWNER/REPO").
pr_number	(integer) the PR number
update	(logical) update an existing comment or post a new one. Defaults to TRUE.

Details

Users can also choose to always post a new comment (this always deletes the previous one).

Value

a gh_response object containing the API response

Examples

## Not run: 
post_comment(
  "this is amazing",
  repo = "<owner>/<repo>",
  pr_number = 3
)

## End(Not run)

---

Set up a covr2gh GitHub Action workflow

Description

Sets up a GitHub Actions workflow that calculates and reports test coverage:

• uses covr::package_coverage().

• on a pull request:

  • calculates test coverage for head.

  • builds a badge (for use in the commit message).

  • initialises or switches to the covr2gh-storage branch.

  • switches to base branch and calculates test coverage.

  • compares coverage for head and base and posts a comment with the main findings.

  • uploads base coverage and badge as artefacts.

  • posts a workflow summary.

• on a push to main:

  • calculates test coverage for head and creates a badge.

  • switches to or creates the covr2gh-storage branch.

  • commits badge (referenced in the README).

Usage

use_covr2gh_action(badge = TRUE)

Arguments

badge

(logical) should a badge be added to README? Defaults to TRUE.

Details

use_covr2gh_action() wraps usethis::use_github_action().

Examples

## Not run: 
use_covr2gh_action()

## End(Not run)

---

Add a coverage README badge

Description

Inserts the markdown text for a coverage badge in the usethis block (between ⁠<!-- badges: start -->⁠ and ⁠<!-- badges: end -->⁠). The src URL for the badge SVG points to a storage branch in the repo(covr2gh-storage). The link out points to the actions workflow page.

Usage

use_covr2gh_badge()

Examples

## Not run: 
use_covr2gh_badge()

## End(Not run)

---