Skip to contents

Use a GitHub Action to QC pull-request-associated issues

Source: R/Actions.R
Action_QCPRIssues.Rd

Install a GitHub Action into a package repository to generate a QC report with QCPR() of issues that will be closed by the triggering pull request. We recommend reviewing the generated action to determine whether you would like to turn any features off. Note: This workflow cannot be triggered when an issue is connected to (or disconnected from) the pull request via the "Development" UI of the PR or issue. In that situation, either trigger the workflow manually, or edit the PR body to mention the issue (such as "Closes #55").

Usage

Action_QCPRIssues(lglOverwrite = FALSE, strPkgRoot = ".")

Arguments

lglOverwrite

(length-1 logical) Whether to overwrite files if they already exist.

strPkgRoot

(length-1 character) The path to the root directory of the package. Will be expanded using pkgload::pkg_path().

Value

The path to the created GitHub Action YAML file (invisibly).

Examples

if (FALSE) { # interactive()

  Action_QCPRIssues()
}