posit-dev / posit-dev/rsconnect-python

deploying "EXTRA_FILES" needs to be explained better

Offen
#354 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation
Vorherrschende Sprache
Python
Sterne
37
Forks
28
Ø Merge
1 T. 3 Std.
Gemergte PRs (30 T.)
7

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit den README-Deploy-Beispielen und der --help-Ausgabe der deploy-Unterbefehle; verfolge dann, wo EXTRA_FILES beschrieben wird. Kläre, wann zusätzliche Dateien einbezogen werden, wie sie sich auf --exclude beziehen und wo sie in der Hierarchie des App-Verzeichnisses erscheinen; abgeschlossen ist die Aufgabe, wenn das dokumentierte Verhalten die gemeldeten Fragen ohne Rätselraten beantwortet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
cli, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.