Skip to content

Commit

Permalink
v1.0.6 -- Update notes on GH setup. Related to r-lib/usethis#1347
Browse files Browse the repository at this point in the history
  • Loading branch information
lcolladotor committed Feb 5, 2021
1 parent 509cab6 commit bfc19e0
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 14 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: biocthis
Title: Automate package and project setup for Bioconductor packages
Version: 1.0.5
Date: 2020-12-15
Version: 1.0.6
Date: 2021-02-05
Authors@R:
c(
person("Leonardo", "Collado-Torres", role = c("aut", "cre"),
Expand Down
16 changes: 10 additions & 6 deletions dev/02_git_github_setup.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ usethis::use_git() ## Choose the option to make the commit, then to restart RStu
## GitHub. You might want to use the `organisation` and `private` arguments
args(usethis::use_github)

## If this is your first time running use_github(), you might have to also run:
usethis::gh_token_help()
usethis::create_github_token()
usethis::edit_r_environ()

## Setup ssh keys as described in detail at
## https://happygitwithr.com/ssh-keys.html

Expand All @@ -27,16 +22,25 @@ usethis::edit_r_profile()
## And add the following to your Rprofile (without the first ##):
## ## For usethis::use_git()
## options(usethis.protocol = "ssh")
##
## Otherwise you might run into this problem
## https://github.com/r-lib/usethis/issues/1347 or similar ones.

## Then re-start R
rstudioapi::restartSession()

## If this is your first time running use_github(), you might have to also run:
usethis::gh_token_help()
usethis::create_github_token()
usethis::edit_r_environ()
## This whole process is documented in detail at
## https://usethis.r-lib.org/articles/articles/git-credentials.html.

## Now run use_github()
usethis::use_github()
## Follow any prompts, such as running on the terminal:
## git push --set-upstream origin master


## Move to the next step: setting up your package core files
rstudioapi::navigateToFile(usethis::proj_path("dev", "03_core_files.R"))

Expand Down
16 changes: 10 additions & 6 deletions inst/templates/02_git_github_setup.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ usethis::use_git() ## Choose the option to make the commit, then to restart RStu
## GitHub. You might want to use the `organisation` and `private` arguments
args(usethis::use_github)

## If this is your first time running use_github(), you might have to also run:
usethis::gh_token_help()
usethis::create_github_token()
usethis::edit_r_environ()

## Setup ssh keys as described in detail at
## https://happygitwithr.com/ssh-keys.html

Expand All @@ -27,16 +22,25 @@ usethis::edit_r_profile()
## And add the following to your Rprofile (without the first ##):
## ## For usethis::use_git()
## options(usethis.protocol = "ssh")
##
## Otherwise you might run into this problem
## https://github.com/r-lib/usethis/issues/1347 or similar ones.

## Then re-start R
rstudioapi::restartSession()

## If this is your first time running use_github(), you might have to also run:
usethis::gh_token_help()
usethis::create_github_token()
usethis::edit_r_environ()
## This whole process is documented in detail at
## https://usethis.r-lib.org/articles/articles/git-credentials.html.

## Now run use_github()
usethis::use_github()
## Follow any prompts, such as running on the terminal:
## git push --set-upstream origin master


## Move to the next step: setting up your package core files
rstudioapi::navigateToFile(usethis::proj_path("dev", "03_core_files.R"))

Expand Down

0 comments on commit bfc19e0

Please sign in to comment.