use_github_links

0th

Percentile

Add GitHub links to DESCRIPTION.

Populates the URL and BugReports fields of DESCRIPTION with https://github.com/<USERNAME>/<REPO> AND https://github.com/<USERNAME>/<REPO>/issues, respectively, unless those fields already exist.

Keywords
internal
Usage
use_github_links(pkg = ".", auth_token = github_pat(),
  host = "https://api.github.com")
Arguments
pkg

Path to package. See as.package for more information.

auth_token

Provide a personal access token (PAT) from https://github.com/settings/tokens. Defaults to the GITHUB_PAT environment variable.

host

GitHub API host to use. Override with the endpoint-root for your GitHub enterprise instance, for example, "https://github.hostname.com/api/v3".

See Also

Other git infrastructure: use_git_hook, use_github, use_git

Aliases
  • use_github_links
Documentation reproduced from package devtools, version 1.13.5, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.