Skip to content

Commit

Permalink
Update NEWS and docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
dbkegley committed Aug 28, 2023
1 parent 1ec3d3a commit 382e35b
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 26 deletions.
17 changes: 10 additions & 7 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@
* Ignore `.env`, `.venv`, and `venv` files only when they reference Python
virtual environments. (#972)

* Add `envManagement`, `envManagementR` and `envManagementPy` args when writing
the `manifest.json`. These args whether Connect should install packages in the
package cache. If `envManagement` is `FALSE` then Connect will not perform any
package installation and it is the administrators responsibility to ensure the
required R/Python packages are available in the runtime environment.
This is especially useful if off-host execution is enabled, when the execution
environment (specified by `--image`) already contains the required packages.
* `deployApp()` and `writeManifest()` accept optional `envManagement`,
`envManagementR`, and `envManagementPy` arguments. These args specify whether
Posit Connect should install packages in the package cache.
If `envManagement` is `FALSE` then Connect will not perform any package
installation and it is the administrator's responsibility to ensure the
required R/Python packages are available in the runtime environment. This is
especially useful if off-host execution is enabled, when the execution
environment (specified by the `image` argument) already contains the required
packages. These values are ignored when
`Applications.ManifestEnvironmentManagementSelection = false`.
Requires Posit Connect `>=2023.07.0`. (#977)

# rsconnect 1.0.2
Expand Down
15 changes: 10 additions & 5 deletions R/deployApp.R
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,12 @@
#' @param image Optional. The name of the image to use when building and
#' executing this content. If none is provided, Posit Connect will
#' attempt to choose an image based on the content requirements.
#' @param envManagement Optional. Should Connect install R and Python packages
#' for this content? (`TRUE`, `FALSE`, or `NULL`). The default, `NULL`, will
#' not write any values to the bundle manifest, and Connect will fall back to
#' the application default environment management strategy, or the server
#' default if no application default is defined.
#' @param envManagement Optional. Should Posit Connect install R and Python
#' packages for this content? (`TRUE`, `FALSE`, or `NULL`).
#' The default, `NULL`, will not write any values to the bundle manifest,
#' and Connect will fall back to the application default environment
#' management strategy, or the server default if no application default
#' is defined.
#'
#' (This option is a shorthand flag which overwrites the values of both
#' `envManagementR` and `envManagementPy`.)
Expand All @@ -155,11 +156,15 @@
#' not write any values to the bundle manifest, and Connect will fall back to
#' the application default R environment management strategy, or the server
#' default if no application default is defined.
#'
#' (This option is ignored when `envManagement` is non-`NULL`.)
#' @param envManagementPy Optional. Should Connect install Python packages
#' for this content? (`TRUE`, `FALSE`, or `NULL`). The default, `NULL`, will
#' not write any values to the bundle manifest, and Connect will fall back to
#' the application default Python environment management strategy, or the server
#' default if no application default is defined.
#'
#' (This option is ignored when `envManagement` is non-`NULL`.)
#' @examples
#' \dontrun{
#'
Expand Down
19 changes: 12 additions & 7 deletions man/deployApp.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 12 additions & 7 deletions man/writeManifest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 382e35b

Please sign in to comment.