posit-dev / posit-dev/rsconnect-python

deploying "EXTRA_FILES" needs to be explained better

Open
#354 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
37
Forks
28
Avg merge
1d 3h
Merged PRs (30d)
7

Description

The deploy subcommands take "EXTRA_FILES" arguments, but it's really unclear how it actually works.

The --help shows:

rsconnect deploy api [OPTIONS] DIRECTORY [EXTRA_FILES]...

And the README shows:

rsconnect deploy api flask-api/ data.csv

But when I try it (eg rsconnect deploy api ./hello/ data.txt), I get an error:

Error: ../data.txt must be under ./hello/.

So I need to have data.txt inside the hello directory? Doesn't everything inside the app directory get included by default? What's the point of EXTRA_FILES then? Is it just to negate a --exclude, as described in the README? What am I missing?

Also, the documentation should clearly state where the extra files get placed inside the app directory hierarchy. One would assume they get placed in the root but why make people guess? The documentation should be more clear.

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 the README deploy examples and the deploy subcommands' --help output, then trace where EXTRA_FILES is described. Clarify when extra files are included, how they relate to --exclude, and where they appear in the app directory hierarchy; done means the documented behavior answers the reported questions without guesswork.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.