ghc_repos_git_clone: Clone assignment repositories

ghc_repos_git_cloneR Documentation

Clone assignment repositories

Description

Clone all students' repositories for a specific assignment. Token with private repo access privileges is required if the students' repositories are private. This function can also be used to update existing local repositories for an assignment (i.e. after initial cloning if the students have made updates in the mean time). If updates are not desired, set pull=TRUE.

Usage

ghc_repos_git_clone(prefix, org, folder = ".", token = NULL, pull = TRUE)

Arguments

prefix

assignment prefix (i.e. repository prefix set for github classroom assignment)

org

organization name (i.e. organization github user)

folder

the target directory where to clone all the repositories to

token

authentication token for github API (https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)

pull

if the repository already exists, whether to update it from the remote (see ghc_repos_git_pull)

Value

repositories data frame, see ghc_repos_git_find_repositories for details

See Also

Other command functions: ghc_repos_copy_to(), ghc_repos_git_add(), ghc_repos_git_commit(), ghc_repos_git_create_branch(), ghc_repos_git_delete_branch(), ghc_repos_git_discard_changes(), ghc_repos_git_pull(), ghc_repos_git_push(), ghc_repos_git_remove(), ghc_repos_git_status(), ghc_repos_git_switch_branch(), ghc_repos_run_git_command()


KopfLab/ghctools documentation built on Feb. 20, 2023, 9:25 a.m.