Fetch all issues associated with a GitHub pull request

Find issues associated with a GitHub pull request, whether they were added via keywords, using the pull request sidebar, or using the issue sidebar. See GitHub Docs: Link a pull request to an issue for details on how issues can become associated with a pull request.

Usage

FetchPRIssueNumbers(
  intPRNumber = GuessPRNumber(strPkgRoot, strOwner, strRepo, strGHToken),
  intPageMax = 100L,
  strPkgRoot = ".",
  strOwner = GetGHOwner(strPkgRoot),
  strRepo = GetGHRepo(strPkgRoot),
  strGHToken = gh::gh_token(),
  envCall = rlang::caller_env()
)

Arguments

intPRNumber

(length-1 integer) The number of the pull request to fetch information about and/or post results to.

intPageMax

(length-1 integer) The maximum number of pages of commits to fetch from the GitHub API. Each page contains up to 100 commits. Defaults to 100, which fetches up to 10,000 commits. You likely never need to increase this number, but try a larger number if a merge involves a very large number of commits in a very large repository.

strPkgRoot

(length-1 character) The path to a directory in the package. Will be expanded using gert::git_find().

strOwner

(length-1 character) GitHub username or organization name.

strRepo

(length-1 character) GitHub repository name.

strGHToken

(length-1 character) GitHub token with permissions appropriate to the action being performed.

envCall

(environment) The environment to use for error reporting. Typically set to rlang::caller_env().

Value

A sorted, unique integer vector of associated issue numbers.

Examples

if (FALSE) { # interactive()

  #You must have at least one pull request open in the GitHub repository
  #associated with the current git repository for this to return any
  #results.

  FetchPRIssueNumbers()
}