python / python/mypy

Why the GitHub Action installs project dependencies via pip download + pip install --find-links

Aperta
#20,990 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation question topic-developer
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Documentation

In action.yml, the GitHub Action installs project dependencies with:

"$VENV_PYTHON" -m pip download --dest="$VENV"/deps .
"$VENV_PYTHON" -m pip install -U --find-links="$VENV"/deps "$VENV"/deps/*

instead of a more direct approach such as:

"$VENV_PYTHON" -m pip install .

I looked through the current file and the original commit that introduced the action (e02804510), but I could not find an explanation for why this two-step install flow was
chosen.

Could you document the intended reason for this design?

Questions I am trying to answer:

  1. Is there a functional advantage over pip install . for this action?
  2. Is the goal to stage artifacts locally before installation, improve debuggability, or work around some pip / GitHub Actions behavior?
  3. If there is no longer a strong reason, would simplifying this step be acceptable?

A short comment in action.yml or a note in the action documentation would help future readers understand the tradeoff.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da action.yml e dal commit originale e02804510 menzionato nell’issue; confronta il flusso pip in due passaggi con l’installazione diretta proposta ed esamina la configurazione circostante dell’action. Documenta la motivazione confermata in action.yml o nella documentazione dell’action, includendo se l’approccio è ancora necessario e quali compromessi comporta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, python
Ambito
ci-cd, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.