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.
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
Write rsconnect manifest in build_site() deploy_to_branch() #1611
Comments
On reflection, I am not actually sure if that workaround is reasonable because |
|
My best workaround so far is to include a package function that generates the manifest when the examples run during #' @title Write a manifest file.
#' @export
#' @description Not a user-side function.
#' @details Writes a `manifest.json` file so the `pkgdown` site
#' can be deployed to RStudio Connect as Git-backed content.
#' @return `NULL` (invisibly).
#' @examples
#' zzz_examplepkg_write_manifest()
zzz_examplepkg_write_manifest <- function() {
if (pkgdown::in_pkgdown()) {
withr::with_dir(
"..",
rsconnect::writeManifest(
appPrimaryDoc = "index.html",
contentCategory = "site"
)
)
}
} |
|
Where are you running |
|
Yes, I was thinking during I do see your point that it is already a big function and difficult to maintain. From a user perspective though, I really enjoy the automatic deployment because those Git setups are indeed complicated. Will some form of support continue in this package? (Or some other |
|
For GitHub actions, we'll move to https://github.com/marketplace/actions/deploy-to-github-pages. Otherwise, no plans to replicate |
Would you be open to creating a
manifest.jsonfile as part ofbuild_site()ordeploy_to_branch()?My team and I heavily use RStudio Connect, and we love Git-backed content. Thanks to
pkgdown::deploy_to_branch()andusethis::use_github_action("pkgdown"), it is almost trivially easy to continuously deploy a package site on Connect. The only snag is that it requiresmanifest.jsonat the top level, andpkgdowndoes not currently create one. My personal workaround is to runbuild_site()locally, runrsconnect::writeManifest()from insidedocs/, then copymanfiest.jsontopkgdown/favicon/. It works, but the extra steps add friction for colleagues who are just getting into package development.The text was updated successfully, but these errors were encountered: