use_github_links: Use GitHub links in URL and BugReports

Description Usage Arguments Examples

View source: R/github.R

Description

Populates the URL and BugReports fields of a GitHub-using R package with appropriate links. The GitHub repo to link to is determined from the current project's GitHub remotes:

Usage

1
2
3
4
5
use_github_links(
  auth_token = deprecated(),
  host = deprecated(),
  overwrite = FALSE
)

Arguments

host, auth_token

Deprecated lifecycle: No longer consulted now that usethis consults the current project's GitHub remotes to get the host and then relies on gh to discover an appropriate token.

overwrite

By default, use_github_links() will not overwrite existing fields. Set to TRUE to overwrite existing links.

Examples

1
2
3
4
## Not run: 
use_github_links()

## End(Not run)

usethis documentation built on Feb. 10, 2021, 5:08 p.m.