Merge branch 'main' into improve-render

salim-b · salim-b · commit c7b167894f96 · 2023-10-04T12:00:34.000+02:00
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -3,3 +3,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^\.github$
diff --git a/.github/.gitignore b/.github/.gitignore
@@ -0,0 +1 @@
+*.html
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,48 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 .Rhistory
 
 inst/doc
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: quarto
 Title: R Interface to 'Quarto' Markdown Publishing System
-Version: 1.2.0.9000
+Version: 1.3
 Authors@R: 
     person(given = "JJ",
            family = "Allaire",
diff --git a/R/publish.R b/R/publish.R
@@ -1,7 +1,7 @@
 
 #' Publish Quarto Documents
 #'
-#' Publish Quarto documents to RStudio Connect, ShinyApps, and RPubs
+#' Publish Quarto documents to Posit Connect, ShinyApps, and RPubs
 #'
 #' @inheritParams rsconnect::deployApp
 #'
@@ -15,9 +15,6 @@
 #' @param render `local` to render locally before publishing; `server` to
 #'   render on the server; `none` to use whatever rendered content currently
 #'   exists locally. (defaults to `local`)
-#' @param server Server name. Use "shinyapps.io" when deploying applications
-#'   to Shinyapps. Use "rpubs.com" when deploying documents to RPubs. Otherwise
-#'   use the domain name or IP address of any RStudio Connect server.
 #' @param ... Named parameters to pass along to `rsconnect::deployApp()`
 #'
 #' @examples
@@ -111,7 +108,7 @@ quarto_publish_doc <- function(input,
     }
 
     # include any explicit resources with app files
-    app_files <- unique(c(app_files, resources))
+    app_files <- unique(c(app_files, unlist(resources)))
 
     # deploy doc
     if (render == "server") {
diff --git a/README.md b/README.md
@@ -19,17 +19,17 @@ The following functions enable you to render and preview Quarto documents and pr
 | [`quarto_render()`](https://quarto-dev.github.io/quarto-r/reference/quarto_render.html)        | Render a file or project       |
 | [`quarto_preview()`](https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html)      | Live preview a file or project |
 | [`quarto_preview_stop()`](https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html) | Stop live previewing           |
-| [`quarto_serve()`](https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html)              | Run interactive document       |
+| [`quarto_run()`](https://quarto-dev.github.io/quarto-r/reference/quarto_run.html)              | Run interactive document       |
 
 ### Publishing
 
-These functions enable you to publish static and interactive documents, websites, and books to [RStudio Connect](https://www.rstudio.com/products/connect/) and [shinyapps.io](https://www.shinyapps.io/):
+These functions enable you to publish static and interactive documents, websites, and books to [Posit Connect](https://posit.co/products/enterprise/connect/) and [shinyapps.io](https://www.shinyapps.io/):
 
 |                                                              |                                        |
 |---------------------------|------------------------------------|
-| [`quarto_publish_doc()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html)  | Publish a document or presentation     |
-| [`quarto_publish_site()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html) | Current version of Quarto              |
-| [`quarto_publish_app()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html)  | Inspect metadata for a file or project |
+| [`quarto_publish_doc()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html)  | Publish a document or presentation                |
+| [`quarto_publish_site()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html) | Publish a website                                 |
+| [`quarto_publish_app()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html)  | Publish a document with Shiny application runtime |
 
 ### Configuration
 
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -1,5 +1,5 @@
 
-url: ~
+url: https://quarto-dev.github.io/quarto-r/
 template:
   bootstrap: 5
 
@@ -25,7 +25,7 @@ reference:
 - title: "Publishing"
   desc: >
     These functions enable you to publish static and interactive documents, websites, and books to
-    [RStudio Connect](https://www.rstudio.com/products/connect/) and [shinyapps.io](https://www.shinyapps.io/):
+    [Posit Connect](https://posit.co/products/enterprise/connect/) and [shinyapps.io](https://www.shinyapps.io/):
   contents:
   - quarto_publish_doc
 
diff --git a/man/quarto_publish_doc.Rd b/man/quarto_publish_doc.Rd
diff --git a/quarto-r.Rproj b/quarto-r.Rproj
@@ -18,6 +18,5 @@ LineEndingConversion: Posix
 
 BuildType: Package
 PackageUseDevtools: Yes
-PackageCleanBeforeInstall: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
 PackageRoxygenize: rd,collate,namespace
diff --git a/tests/testthat/test-render.R b/tests/testthat/test-render.R
@@ -8,7 +8,7 @@ test_that("R Markdown documents can be rendered", {
   skip_if(is.null(quarto_path()))
   quarto_render("test.Rmd", quiet = TRUE)
   expect_true(file.exists("test.html"))
-  unlink("test-render.html")
+  unlink("test.html")
 })
 
 
diff --git a/vignettes/publishing.Rmd b/vignettes/publishing.Rmd
@@ -9,13 +9,13 @@ vignette: >
 
 ## Overview
 
-The **quarto** package includes several functions that enable you to publish static and interactive documents, websites, and books to [RStudio Connect](https://www.rstudio.com/products/connect/) and [shinyapps.io](https://www.shinyapps.io/). When publishing to RStudio Connect, both simple content publishing (local rendering) as well as code publishing (rendering on Connect) are supported.
+The **quarto** package includes several functions that enable you to publish static and interactive documents, websites, and books to [Posit Connect](https://posit.co/products/enterprise/connect/) and [shinyapps.io](https://www.shinyapps.io/). When publishing to Posit Connect, both simple content publishing (local rendering) as well as code publishing (rendering on Connect) are supported.
 
 ## Accounts
 
-Before publishing to RStudio Connect or shinyapps.io you should ensure that you have an account configured for publishing. 
+Before publishing to Posit Connect or shinyapps.io you should ensure that you have an account configured for publishing. 
 
-For RStudio Connect, use the `rsconnect::connectUser()` function for the server you are publishing to. For example:
+For Posit Connect, use the `rsconnect::connectUser()` function for the server you are publishing to. For example:
 
 ```r
 rsconnect::connectUser(server = "rsc.example.com")
@@ -34,7 +34,7 @@ Note that you can copy and paste this code from the [Tokens](https://www.shinyap
 
 ## Documents
 
-Use the `quarto_publish_doc()` function to publish a single document to RStudio Connect. Note that the very _first time_ that you publish you should specify both the `server` and `account` that you want to use for publishing. For example:
+Use the `quarto_publish_doc()` function to publish a single document to Posit Connect. Note that the very _first time_ that you publish you should specify both the `server` and `account` that you want to use for publishing. For example:
 
 ```r
 library(quarto)
@@ -57,7 +57,7 @@ quarto_publish_doc("document.qmd",
 
 ## Websites
 
-Use the `quarto_publish_site()` function to publish a [website](https://quarto.org/docs/websites/) or [book](https://quarto.org/docs/books/) to RStudio Connect. Note that the very _first time_ that you publish you should specify both the `server` and `account` that you want to use for publishing. For example:
+Use the `quarto_publish_site()` function to publish a [website](https://quarto.org/docs/websites/) or [book](https://quarto.org/docs/books/) to Posit Connect. Note that the very _first time_ that you publish you should specify both the `server` and `account` that you want to use for publishing. For example:
 
 ```r
 library(quarto)
@@ -79,9 +79,9 @@ quarto_publish_site(server = "rsc.example.com", account = "njones",
 
 ## Interactive Docs
 
-You can publish Shiny [interactive documents](https://quarto.org/docs/interactive/shiny/) to either RStudio Connect or shinyapps.io. 
+You can publish Shiny [interactive documents](https://quarto.org/docs/interactive/shiny/) to either Posit Connect or shinyapps.io. 
 
-To publish to RStudio Connect, specify both the `server` and `account` that you want to use for publishing (this is required for the first publish only). For example:
+To publish to Posit Connect, specify both the `server` and `account` that you want to use for publishing (this is required for the first publish only). For example:
 
 ```r
 library(quarto)

Original file line number	Diff line number	Diff line change
`@@ -2,3 +2,4 @@`
`2`	`2`	`.Rhistory`
`3`	`3`
`4`	`4`	`inst/doc`
	`5`	`+docs`