posit-dev / posit-dev/connectapi

bundle_dir and rsconnect::writeManifest

Open
#78 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature size:med
Dominant language
R
Stars
54
Forks
27
Avg merge
1d 3m
Merged PRs (30d)
1

Description

Hi,

Thanks again for this package!

My issue is more an advice/feature request. The TL;DR is: connectapi::bundle_dir includes the whole directory in the bundle, while in rsconnect::writeManifest one can specify which files to add in the manifest.json and this is a bit "inconsistent".

So, would it be possible to use manifest.json (its files values to be more specific) to create the bundle instead of adding all the files in the directory?

The long story is the following: I am building a new deployment job in a Gitlab CI pipeline using connectapi instead of the RStudio Connect API endpoints. One of the trickiest part of such job is that RSC uses the packages currently installed in the environment to create a packrat environment in the deployment server, so I am using packrat in the pipeline to install all the dependencies for a given content, then generate the manifest, then generate the bundle... So if I do nothing to prevent it, the big packrat folder is included in the bundle. Of course I can delete it before calling connectapi::bundle_dir, but given that manifest.json is "required" in the bundle, why not use it to grab just what is needed, right?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with connectapi::bundle_dir and compare its behavior with rsconnect::writeManifest. Review how manifest.json files values could determine bundle contents, using the reported GitLab CI and packrat case as context. Done means the bundle includes only the manifest-selected files rather than the entire directory, while still including manifest.json.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.