pb_list: List all assets attached to a release

Description Usage Arguments Details Value Examples

View source: R/pb_list.R

Description

List all assets attached to a release

Usage

1
2
3
4
5
6
pb_list(
  repo = guess_repo(),
  tag = NULL,
  ignore = "manifest.json",
  .token = get_token()
)

Arguments

repo

Repository name in format "owner/repo". Will guess the current repo if not specified.

tag

which release tag do we want information for? If NULL (default), will return a table for all available release tags.

ignore

a list of files to ignore (if downloading "all" because file=NULL).

.token

GitHub authentication token. Typically set from an environmental variable, e.g. in a .Renviron file or with Sys.setenv(GITHUB_TOKEN = "xxxxx"), which helps prevent accidental disclosure of a secret token when sharing scripts.

Details

To preserve path information, local path delimiters are converted to .2f when files are uploaded as assets. Listing will display the local filename, with asset names converting the .2f escape code back to the system delimiter.

Value

a data.frame of release asset names, (normalized to local paths), release tag, timestamp, owner, and repo.

Examples

1
2
3
4
## Not run: 
pb_list("cboettig/piggyback-tests")

## End(Not run)

piggyback documentation built on Feb. 25, 2020, 5:08 p.m.