posit-dev / posit-dev/rsconnect-python
add support for .connectignore
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 37
- Forks
- 28
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 7
Description
- specifying files to ignore via the
--excludeoption makes for very long command line arguments - the exclude patterns do not work consistently, see #320
- our current globbing implementation is a bit limited
- the meaning of
extra_filesis not easy to reason about across app modes, see #354
❯ rsconnect deploy voila
Usage: rsconnect deploy voila [OPTIONS] PATH [EXTRA_FILES]...
❯ rsconnect deploy notebook
Usage: rsconnect deploy notebook [OPTIONS] FILE [EXTRA_FILES]...
❯ rsconnect deploy streamlit
Usage: rsconnect deploy streamlit [OPTIONS] DIRECTORY [EXTRA_FILES]...
Introducing a .connectignore would make it simpler to document which files should be ignored by a deployment.
pathspec looks like an appealing candidate for enhanced wildcard support.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the globbing implementation in rsconnect/models.py around line 158, then trace the deploy voila, notebook, and streamlit command paths and their handling of --exclude and EXTRA_FILES. Review python-pathspec as the proposed wildcard implementation. Done means .connectignore is supported and exclusion behavior is consistent across the listed app modes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100