Skip to content

Commit

Permalink
docs: Add git package packing doc (#4750)
Browse files Browse the repository at this point in the history
Add git package packing docs

Signed-off-by: Sherlock113 <[email protected]>
  • Loading branch information
Sherlock113 authored May 22, 2024
1 parent a882bfb commit 1977c42
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/source/guides/build-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,17 @@ this behavior by setting the ``lock_packages`` field to ``false``:
requirements_txt: "requirements.txt"
lock_packages: false
When including Python packages from GitHub repositories, use the ``pack_git_packages`` option (it defaults to ``true``) to control whether these packages should be cloned and packaged during the build process. This is useful for dependencies that may not be available via standard PyPI sources or for ensuring consistency with specific versions (for example, tags and commits) of a dependency directly from a Git repository.

.. code-block:: yaml
python:
pack_git_packages: true # Enable packaging of Git-based packages
packages:
- "git+https://github.com/username/repository.git@abcdef1234567890abcdef1234567890abcdef12"
Note that ``lock_packages`` controls whether the versions of all dependencies, not just those from Git, are pinned at the time of building the Bento. Disabling ``pack_git_packages`` will also disable package locking (``lock_packages``) unless explicitly set.

Python wheels
"""""""""""""

Expand Down

0 comments on commit 1977c42

Please sign in to comment.