gl_repository {gitlabr}

Access to repository files in GitLab

Description

Access to repository files in GitLab

For gl_file_exists dots are passed on to gl_list_files() and GitLab API call

Get a file from a GitLab repository

Usage

gl_repository(project, req = c("tree"), ref = get_main(), ...)

gl_file_exists(project, file_path, ref, ...)

gl_get_file(
  project,
  file_path,
  ref = get_main(),
  to_char = TRUE,
  api_version = 4,
  ...
)

Arguments

project

id (preferred way) or name of the project. Not repository name.

req

request to perform on repository (everything after '/repository/' in GitLab API, as vector or part of URL)

ref

name of ref (commit branch or tag). Default to 'main'.

...

passed on to gitlab() API call

file_path

path to file

to_char

flag if output should be converted to char; otherwise it is of class raw

api_version

a switch to force deprecated GitLab API v3 behavior. See details section "API version" of gl_connection()

Value

Tibble of files available in the branch with descriptive variables.

Examples

## Not run: 
# Set GitLab connection for examples
set_gitlab_connection(
  gitlab_url = "https://gitlab.com",
  private_token = Sys.getenv("GITLAB_COM_TOKEN")
)

# Access repository
# _All files
gl_repository(project = "<<your-project-id>>")
# _All contributors
gl_repository(project = "<<your-project-id>>", "contributors")
# _Get content of one file
gl_get_file(project = "<<your-project-id>>", file_path = "README.md")
# _Test if file exists
gl_file_exists(
  project = "<<your-project-id>>",
  file_path = "README.md",
  ref = "main"
)

## End(Not run)