get_release_info: Retrieve information about a github repo

View source: R/get_release_info.R

get_release_infoR Documentation

Retrieve information about a github repo

Description

Given an repository on GitHub, retrieve the information about it from the GitHub API and read it into R.

Usage

get_release_info(repo_name, git_pat = NULL, verbose = TRUE)

Arguments

repo_name

The full name of the repo to get bookdown chapters from. e.g. "jhudsl/OTTR_Template"

git_pat

If private repositories are to be retrieved, a github personal access token needs to be supplied. If none is supplied, then this will attempt to grab from a git pat set in the environment with usethis::create_github_token(). Authorization handled by get_git_auth

verbose

TRUE/FALSE do you want more progress messages?

Value

a data frame with the repository's release information: tag_name and tag_date. NAs are returned in these columns if there are no releases.

Examples

## Not run: 

release_info <- get_release_info("jhudsl/OTTR_Template")

## End(Not run)

jhudsl/cow documentation built on April 17, 2025, 3:14 p.m.