Skip to content

Full book is now deployed to gh-pages to be deployed to Connect cloud #1513

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: main
Choose a base branch
from
Open

Full book is now deployed to gh-pages to be deployed to Connect cloud #1513

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
2095921
Full book is now deployed to gh-pages to be deployed to Connect cloud…
cderv Nov 26, 2025
380a951
Fix action syntax
cderv Nov 26, 2025
11279ba
Book needs to be built on workflow dispatch
cderv Nov 26, 2025
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
25 changes: 10 additions & 15 deletions .github/workflows/Book.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ on:
- '.github/workflows/Book.yaml'
workflow_dispatch:
inputs:
ghpages:
description: 'Build gitbook with pandoc devel and deploy gitbook to gh-page for checking differences'
publish:
description: 'publish the book to github pages for connect cloud deployment'
required: false
default: true
default: false
type: boolean

name: Build and deploy book

Expand All @@ -45,17 +46,15 @@ jobs:

steps:
- name: Checkout Repo
uses: actions/checkout@v4
uses: actions/checkout@v6

- name: Install R
uses: r-lib/actions/setup-r@v2

- name: Install Pandoc
uses: r-lib/actions/setup-pandoc@v2
with:
# install nightly when checking on gh-pages
pandoc-version: ${{ github.event.inputs.ghpages && 'nightly' || '3.8' }}
token: ${{ secrets.GITHUB_TOKEN }}
pandoc-version: latest

- name: Install TinyTeX
uses: r-lib/actions/setup-tinytex@v2
Expand Down Expand Up @@ -91,24 +90,20 @@ jobs:
run: make -C inst/examples gitbook bs4_book

- name: Build and Deploy all book
if: github.event_name == 'push'
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
env:
CONNECT_API_KEY: ${{ secrets.RSC_BOOKDOWN_ORG_TOKEN }}
CONTENT_ID: 3
run: make -C inst/examples all

- name: Build Gitbook only
env:
DEPLOY_GH_PAGES: ${{ github.event.inputs.ghpages }}
if: github.event_name == 'workflow_dispatch'
run: make -C inst/examples gitbook

- name: Deploy Gitbook to gh-pages
if: github.event_name == 'workflow_dispatch' && github.event.inputs.ghpages
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: inst/examples/_book
clean: true
dry-run: ${{ (github.event_name == 'workflow_dispatch' && (github.event.inputs.publish == 'false' || github.event.inputs.publish == false)) || false }}

- name: Upload book folder for debug
if: failure()
Expand Down
36 changes: 0 additions & 36 deletions inst/examples/_render.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
quiet = "--quiet" %in% commandArgs(FALSE)
formats = commandArgs(TRUE)
# travis is still use for github page deployment
# TODO: Remove github page deployment
ghpages = identical(Sys.getenv("DEPLOY_GH_PAGES", NA), "true")


src = (function() {
Expand Down Expand Up @@ -34,44 +31,11 @@ for (f in list.files('_book', '[.]html$', full.names = TRUE)) {
x = readLines(f)

if (length(i <- grep('^\\s*<body>\\s*$', x)) == 0) next
# patch HTML files when published to gh-pages to redirect to bookdown.org
if (ghpages) x[i[1]] = '<body onload="window.location = \'https://bookdown.org/yihui\'+location.pathname">'
i = grep('<i class="fa fa-circle-o-notch fa-spin"></i><a href="./">.+</a>', x)[1]
# shorter title on the toolbar
if (!is.na(i)) x[i] = gsub('bookdown: ', '', x[i], fixed = TRUE)
# Remove some lines when published to gh-pages
if (ghpages) {
i = c(
grep('&lt;bytecode: 0x[0-9a-f]+&gt;$', x),
grep('^\\s*<meta name="generator" content="bookdown [.0-9]+ and GitBook [.0-9]+" />$', x),
grep('^<meta name="date" content="[-0-9]+" />$', x)
)
if (length(i)) x = x[-i]
}

writeLines(x, f)
}

# When several format are rendered, usually when make all is called,
# then we publish everything to bookdown.org
if (length(formats) > 1 && !ghpages) {
message(">> Publishing Books")
if (!is.na(Sys.getenv("CI", NA))) {
# On CI connect to server, using API KEY and deploy using appId
rsconnect::addServer('https://bookdown.org', 'bookdown.org')
rsconnect::connectApiUser(
account = 'GHA', server = 'bookdown.org',
apiKey = Sys.getenv('CONNECT_API_KEY')
)
rsconnect::deploySite(
appId = Sys.getenv('CONTENT_ID'),
server = 'bookdown.org',
render = 'none', logLevel = 'verbose',
forceUpdate = TRUE)
} else {
# for local deployment when rsconnect/ is available
bookdown::publish_book('bookdown', server = 'bookdown.org', render = 'none')
}
}

setwd(owd)
Loading