Skip to content

CNAME argument for publishGitbook() #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

CNAME argument for publishGitbook() #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
787b58e
add CNAME parameter to add CNAME file when publishing
wabarr May 8, 2014
87371a9
create CNAME in the _book dir
wabarr May 8, 2014
8b961b7
updated documentation
wabarr May 8, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions R/publishGitbook.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,25 @@
#' @param repo the github repository. Should be of form username/repository
#' @param out.dir location of the built gitbook.
#' @param message commit message.
#' @param CNAME web address to be added to CNAME file on github for custom domain names
#'
#' @export
publishGitbook <- function(repo,
out.dir=paste0(getwd(), '/_book'),
message='Update built gitbook') {
message='Update built gitbook',
CNAME = ""
) {
test <- system('git --version', ignore.stderr=TRUE, ignore.stdout=TRUE, show.output.on.console=FALSE)
if(test != 0) { stop('Git does not appear to be installed.')}
cmd <- paste0(


if(CNAME != ""){
fileConn<-file(paste0(out.dir,"/CNAME"))
writeLines(CNAME, fileConn)
close(fileConn)
}

cmd <- paste0(
"cd ", out.dir, " \n",
"git init \n",
"git commit --allow-empty -m '", message,"' \n",
Expand Down
5 changes: 4 additions & 1 deletion man/publishGitbook.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
\title{Publish the built gitbook to Github.}
\usage{
publishGitbook(repo, out.dir = paste0(getwd(), "/_book"),
message = "Update built gitbook")
message = "Update built gitbook", CNAME = "")
}
\arguments{
\item{repo}{the github repository. Should be of form
Expand All @@ -12,6 +12,9 @@ publishGitbook(repo, out.dir = paste0(getwd(), "/_book"),
\item{out.dir}{location of the built gitbook.}

\item{message}{commit message.}

\item{CNAME}{web address to be added to CNAME file on
github for custom domain names}
}
\description{
Note that this is a wrapper to system \code{git} call.
Expand Down