gh_reset_remote: Reset Remote GitHub Remote Repository (Deprecated function)

In galacticpolymath/GPpub: Galactic Polymath Lesson Publishing Tools

Reset Remote GitHub Remote Repository (Deprecated function)

Description

Change the GitHub URL associated with this project (i.e. after you rename the repo on https://github.com/galacticpolymath) or after you've "forked" a project to make a new language version of the project. That is, you're specifying an existing GitHub Repository's URL that you want your local RStudio session to connect to when tracking changes. You don't have to specify the whole URL, just the specific name of the project (new_proj_name) exactly as it's spelled on GitHub.

Usage

gh_reset_remote(
  new_proj_name,
  WD = "?",
  check_current_gh = FALSE,
  run_check_wd = TRUE
)

Arguments

new_proj_name	The name of the new (empty) repo you want to connect to (should be exactly as it is named on https://github.com/galacticpolymath); It's just the project name–a full URL is not expected.
WD	working directory; default= getwd()
check_current_gh	do you want to check whether the current listed GitHubURL in the front-matter.yml is good? If T, will throw an error and stop if a current GitHub connection does not exist. default=F
run_check_wd	logical; do you want to run check_wd()? Basically looks for files and folders you expect in a valid lesson project. default=TRUE

Details

Will run some validation checks and let you know whether the new_proj_name repo exists on the web. May also prompt to run editor() to initialize some fields.

See Also

Other GitHub Functions: gh_push_forked_repo()

galacticpolymath/GPpub documentation built on April 5, 2025, 6:04 p.m.