back_up_gh_orgs: Back up GitHub organization repositories

View source: R/back_up_gh.R

back_up_gh_orgsR Documentation

Back up GitHub organization repositories

Description

The function uses gh_token to access GitHub API URL to download organization repositories. It returns all backup materials in a folder on users' local machine.

Usage

back_up_gh_orgs(gh_token, backup_path, orgs_name = NULL)

Arguments

gh_token

Token number from GitHub website.

backup_path

Directory where backup materials are located.

orgs_name

Name of the organization. A vector of names. Otherwise the function will backup all organizations that are associated with your account.

Value

Backup of GitHub repository in the directory where backup_path is

Examples

## Not run: 
back_up_gh_orgs(
  gh_token = "abcdefghijklmnopqrstuvwxyz01234567890123",
  backup_path = "C:/Users/ghbackup/",
  orgs_name = c("nmfs-fish-tools", "nmfs-general-modeling-tools")
)

back_up_gh_orgs(
  gh_token = gh::gh_token(),
  backup_path = "C:/Users/ghbackup/",
  orgs_name = c("nmfs-fish-tools", "nmfs-general-modeling-tools")
)

## End(Not run)

Bai-Li-NOAA/ghBackup documentation built on April 14, 2025, 7:08 p.m.