Description Usage Arguments Details Value See Also Examples
It collects all dependencies and project packages installed in local project environment together with master scripts and artifacts and zips them into a single zip file.
1 |
prj |
project object to zip. if not passed will zip the loaded project or the default whichever exists. Will init default project from the working directory if no default project exists. (type: rsuite_project, default: NULL) |
path |
folder path to put output zip into. If the folder does not exist, will
create it. (type: character: default: |
zip_ver |
if passed enforce the version of the zip package to the passed value. Expected form of version is DD.DD. (type: character, default: NULL) |
Zip package generated is stamped with version. It can be enforced with zip_ver parameter (zip will have suffix <zip_ver>x in the case). If the version is not enforced it is detected out of ZipVersion setting in project PARAMETERS file or from the maximal project packages version number. In that case, revision number is appended to version: version number will be <zip_ver>_<rc_ver>. Check for changes in project sources is performed for zip package consistency.
Before building zip package project is built. If revision number detected project packages will have version altered: revision will be added as least number to package version.
Logs all messages from the building process onto rsuite logger. Use logging::setLevel
to control logs verbosity. DEBUG level turns on building and downloading messages.
invisible file path to pack file created. The file name will be in form <ProjectName>_<version>.zip
Other in project management: prj_build
,
prj_clean_deps
, prj_init
,
prj_install_deps
, prj_load
,
prj_lock_env
, prj_pack
,
prj_start_package
, prj_start
,
prj_unload
1 2 3 4 5 6 7 8 9 | # create exemplary project base folder
prj_base <- tempfile("example_")
dir.create(prj_base, recursive = TRUE, showWarnings = FALSE)
# start project
prj <- prj_start("my_project", skip_rc = TRUE, path = prj_base)
# build deployment zip
zip_fpath <- prj_zip(prj = prj, path = tempdir(), zip_ver = "1.0")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.