Create a manifest.json file for Connect Cloud

A dependency file is required to let Connect Cloud know which R libraries to include in a given deployment. Any content that has R code needs a manifest.json file included in the GitHub repository.

Note

What about renv?

Connect Cloud does not currently support renv to setup the R environment. It captures everything it needs from manifest.json, including the packages and R version.

However, please note that you may see reference to renv in the logs as Connect Cloud processes your manifest file during deployment.

General Deployments

Generate a manifest.json file with the rsconnect library.

rsconnect::writeManifest()

Websites and Bookdown

If you are deploying Quarto websites, R Markdown websites, or Bookdown documents, please set the contentCategory argument to site.

rsconnect::writeManifest(contentCategory = "site")

File Location

The manifest.json file can either be in the root directory of the repository or in the subdirectory with the primary application file.

Private Packages

Connect Cloud allows you to use your R packages published to private GitHub repositories. This feature requires a paid plan that includes private GitHub capability.

Recommended procedure to include private packages

1. Make sure that you have granted the Connect Cloud GitHub app with access to the repository containing the private dependency. See our GitHub App docs for details.

2. Use the install_github function from the remotes package to add desired private packages to your application locally – when installed in this way, rsconnect will be able to add the required information to manifest.json for Connect Cloud to locate your private package.

3. Generate your mainfest.json per the instructions above.

This technique allows you to avoid including GitHub credentials in your manifest.json.