python / python/mypy

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

Open
#20,990 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation question topic-developer
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

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.

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 action.yml and the original commit e02804510 mentioned in the issue; compare the two-step pip flow with the proposed direct install and inspect the surrounding action configuration. Document the confirmed rationale in action.yml or the action documentation, including whether the approach remains necessary and what tradeoffs it has.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.