Set up GitHub access for private repositories

Interactive setup wizard that configures authentication for reading CSV files from private GitHub repositories. This function:

Usage

ms_setup_github(repo = NULL)

Arguments

repo

Optional repository slug in "owner/name" form. When supplied, the stored PAT is additionally checked against it, which is the quickest way to confirm the token carries the permissions a private repository needs. When NULL (the default) the PAT is set up and stored without verifying any particular repository.

Value

Invisibly returns the detected PAT.

Details

1. Checks that git is installed and available

2. Guides creation of a GitHub Personal Access Token (PAT) with repo scope if one is not already stored

3. Stores the PAT securely via gitcreds for future use

4. Verifies that authentication works by testing access to a repository

Run this function once before using read_github_csv() to access private repositories. The stored PAT will be used automatically for subsequent requests.

A Personal Access Token (PAT) is a GitHub credential that allows API access. The repo scope is required to read from private repositories. Tokens are stored locally by the gitcreds package in your system's credential manager.

If your organization uses Single Sign-On (SSO), you may need to authorize your PAT for that organization at https://github.com/settings/tokens after creating it.

See also

read_github_csv() for reading CSV files from GitHub, github_raw_url() for building raw GitHub URLs.

Examples

if (FALSE) { # \dontrun{
# Set up and store a PAT.
ms_setup_github()

# Optionally also verify the token can read a specific repository.
ms_setup_github(repo = "your-org/your-private-repo")

# After setup, you can read CSVs from private repos
data <- read_github_csv("path/to/file.csv", repo = "your-org/your-repo")
} # }