is_pull_merged: Get if a pull request has been merged

Description Usage Arguments Value

View source: R/pull-requests-deprecated.R

Description

https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged

Usage

1
2
3
4
5
6
7
is_pull_merged(
  pull_request,
  repo,
  token = gh_token(),
  api = getOption("github.api"),
  ...
)

Arguments

pull_request

(integer) The number assigned to the pull request.

repo

(string) The repository specified in the format: owner/repo.

token

(string, optional) The personal access token for GitHub authorisation. Default: value stored in the environment variable GITHUB_TOKEN or GITHUB_PAT.

api

(string, optional) The URL of GitHub's API. Default: the value stored in the environment variable GITHUB_API or https://api.github.com.

...

Parameters passed to gh_get().

Value

TRUE if the pull request has been merged, FALSE otherwise (see GitHub's API documentation for details).


ChadGoymer/githapi documentation built on March 28, 2020, 11:36 p.m.