Retrieves the same file from multiple repositories within an organisation. It accepts either a character vector of repository names or a data frame containing a `repo_name` column. The function returns a named list of raw GitHub API responses.
Usage
get_files(
repos,
org,
file_name,
token = get_token(),
try_common_locations = TRUE
)Arguments
- repos
A character vector of repository names or a data frame with a `repo_name` column.
- org
The GitHub organisation name.
- file_name
string Detail the name of the file being retrieved and include the file extension, for example README.md or README.Rmd.
- token
A GitHub installation access token or personal access token.
- try_common_locations
If `TRUE` (the default), the function checks common alternative locations (`.github/`, `docs/`, lowercase) in addition to the exact path. Set to `FALSE` when the exact path is known.
Value
A named list where each element contains the raw API response for the file retrieved from a repository.
Examples
if (FALSE) { # \dontrun{
files_raw <- get_files(
repos = c("repo1", "repo2"),
org = "my-org",
file_name = "README.md"
)
} # }