gh_list_files: GitHub files

In fmichonneau/carpenter: Tools to work with The Carpentries GitHub repositories

GitHub files

Description

Gets the list of files from a GitHub repository.

Usage

gh_list_files_raw(owner, repo, path = NULL, ...)

gh_list_files(owner, repo, path = NULL, ...)

Arguments

owner	user or organization for the repository
repo	name of the repository
path	optional sub-folder within the repository
...	additional parameters to be passed to gh (e.g. .token)

Details

By default, it only returns the files in the root of the repository. You can specify a path to get the content of a sub-folder. There is no way to get all content from a repository at this stage.

gh_list_files returns the name of the file, its path, and the URL for the HTML rendering of the file.

Value

• gh_list_files_raw returns a list (default from gh).

• gh_list_files returns a tibble.

fmichonneau/carpenter documentation built on July 5, 2022, 7:08 a.m.